SqlServerServerResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Azure.Sql / SqlServerServerResource

SqlServerServerResource

Docs Reference TypeScript APIs Aspire.Hosting.Azure.Sql SqlServerServerResource

Handle TypeScript

📦 Aspire.Hosting.Azure.Sql v13.2.0-preview.1.26159.1

interface SqlServerServerResource
  extends IComputeResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly databases: Dict<string,string>;
  entrypoint: string;
  readonly host: EndpointReferenceExpression;
  readonly jdbcConnectionString: ReferenceExpression;
  readonly name: string;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  shellExecution: boolean;
  readonly uriExpression: ReferenceExpression;
  readonly userNameReference: ReferenceExpression;
  addDatabase(
      name: string,
      databaseName?: string): SqlServerDatabaseResource;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): SqlServerServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): SqlServerServerResource;
  withHostPort(port: number): SqlServerServerResource;
  withPassword(password: ParameterResource): SqlServerServerResource;
}

Implements

• IComputeResource
• IManifestExpressionProvider
• IResource
• IResourceWithArgs
• IResourceWithConnectionString
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IValueProvider
• IValueWithReferences

Search members of SqlServerServerResource…

method property

18 members Clear filters

Properties

property connectionStringExpression ReferenceExpression get

Gets the ConnectionStringExpression property

property databases Dict<string,string> get

Gets the Databases property

property entrypoint string get · set

Gets the Entrypoint property

property host EndpointReferenceExpression get

Gets the Host property

property jdbcConnectionString ReferenceExpression get

Gets the JdbcConnectionString property

property name string get

Gets the Name property

property port EndpointReferenceExpression get

Gets the Port property

property primaryEndpoint EndpointReference get

Gets the PrimaryEndpoint property

property shellExecution boolean get · set

Gets the ShellExecution property

property uriExpression ReferenceExpression get

Gets the UriExpression property

property userNameReference ReferenceExpression get

Gets the UserNameReference property

Methods

method addDatabase builder

Adds a SQL Server database resource

addDatabase(
    name: string,
    databaseName?: string): SqlServerDatabaseResource

Parameters

name string

databaseName string optional

Returns

SqlServerDatabaseResource

method withDataBindMount builder

Adds a bind mount for the SQL Server data folder

withDataBindMount(
    source: string,
    isReadOnly?: boolean): SqlServerServerResource

Parameters

source string

isReadOnly boolean optional = False

Returns

SqlServerServerResource

method withDataVolume builder

Adds a named volume for the SQL Server data folder

withDataVolume(
    name?: string,
    isReadOnly?: boolean): SqlServerServerResource

Parameters

name string optional

isReadOnly boolean optional = False

Returns

SqlServerServerResource

method withHostPort builder

Sets the host port for the SQL Server resource

withHostPort(port: number): SqlServerServerResource

Parameters

port number

Returns

SqlServerServerResource

method withPassword builder

Configures the password for the SQL Server resource

withPassword(password: ParameterResource): SqlServerServerResource

Parameters

password ParameterResource

Returns

SqlServerServerResource