AzureSqlServerResource

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

AzureSqlServerResource

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

Handle TypeScript

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

interface AzureSqlServerResource
  extends IAzureResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithParameters,
    IValueProvider,
    IValueWithReferences,
    IAzurePrivateEndpointTarget,
    IAzurePrivateEndpointTargetNotification {
  readonly connectionStringExpression: ReferenceExpression;
  readonly databases: Dict<string,string>;
  readonly hostName: ReferenceExpression;
  readonly isContainer: boolean;
  readonly jdbcConnectionString: ReferenceExpression;
  readonly name: string;
  readonly outputs: Dict<string,any>;
  readonly parameters: Dict<string,any>;
  readonly port: ReferenceExpression;
  readonly secretOutputs: Dict<string,string>;
  readonly uriExpression: ReferenceExpression;
  addDatabase(
      name: string,
      databaseName?: string): AzureSqlDatabaseResource;
  runAsContainer(configureContainer?: (obj: SqlServerServerResource) => void): AzureSqlServerResource;
  withAdminDeploymentScriptStorage(storage: AzureStorageResource): AzureSqlServerResource;
}

Implements

• IAzureResource
• IManifestExpressionProvider
• IResource
• IResourceWithConnectionString
• IResourceWithParameters
• IValueProvider
• IValueWithReferences
• IAzurePrivateEndpointTarget
• IAzurePrivateEndpointTargetNotification

Search members of AzureSqlServerResource…

method property

14 members Clear filters

Properties

property connectionStringExpression ReferenceExpression get

Gets the ConnectionStringExpression property

property databases Dict<string,string> get

Gets the Databases property

property hostName ReferenceExpression get

Gets the HostName property

property isContainer boolean get

Gets the IsContainer property

property jdbcConnectionString ReferenceExpression get

Gets the JdbcConnectionString property

property name string get

Gets the Name property

property outputs Dict<string,any> get

Gets the Outputs property

property parameters Dict<string,any> get

Gets the Parameters property

property port ReferenceExpression get

Gets the Port property

property secretOutputs Dict<string,string> get

Gets the SecretOutputs property

property uriExpression ReferenceExpression get

Gets the UriExpression property

Methods

method addDatabase builder

Adds an Azure SQL database resource

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

Parameters

name string

databaseName string optional

Returns

AzureSqlDatabaseResource

method runAsContainer builder

Configures the Azure SQL server to run locally in a SQL Server container

runAsContainer(configureContainer?: (obj: SqlServerServerResource) => void): AzureSqlServerResource

Parameters

configureContainer (obj: SqlServerServerResource) => void optional

Returns

AzureSqlServerResource

method withAdminDeploymentScriptStorage builder

Configures the Azure SQL server to use a specific storage account for deployment scripts

withAdminDeploymentScriptStorage(storage: AzureStorageResource): AzureSqlServerResource

Parameters

storage AzureStorageResource

Returns

AzureSqlServerResource