AzureSqlServerResource

Handle

📦 Aspire.Hosting.Azure.Sql v13.3.0

interface AzureSqlServerResource
  extends IAzureResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithParameters,
    IValueProvider,
    IValueWithReferences,
    IAzureNspAssociationTarget,
    IAzurePrivateEndpointTarget,
    IAzurePrivateEndpointTargetNotification {
  readonly azureSqlDatabases: Dict<string,Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource>;
  readonly connectionStringExpression: ReferenceExpression;
  readonly databases: Dict<string,string>;
  readonly fullyQualifiedDomainName: BicepOutputReference;
  readonly hostName: ReferenceExpression;
  readonly id: BicepOutputReference;
  readonly isContainer: boolean;
  readonly jdbcConnectionString: ReferenceExpression;
  readonly nameOutputReference: BicepOutputReference;
  readonly port: ReferenceExpression;
  readonly uriExpression: ReferenceExpression;
  addDatabase(
      name: string,
      databaseName?: string): AzureSqlDatabaseResource;
  runAsContainer(configureContainer?: (obj: SqlServerServerResource) => Promise<void>): AzureSqlServerResource;
  withAdminDeploymentScriptStorage(storage: AzureStorageResource): AzureSqlServerResource;
  withAdminDeploymentScriptSubnet(subnet: AzureSubnetResource): AzureSqlServerResource;
}

15 members

Properties

property azureSqlDatabases Dict<string,Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource> get

Gets the AzureSqlDatabases property

property connectionStringExpression ReferenceExpression get

Gets the ConnectionStringExpression property

property databases Dict<string,string> get

Gets the Databases property

property fullyQualifiedDomainName BicepOutputReference get

Gets the FullyQualifiedDomainName property

property hostName ReferenceExpression get

Gets the HostName property

property id BicepOutputReference get

Gets the Id property

property isContainer boolean get

Gets the IsContainer property

property jdbcConnectionString ReferenceExpression get

Gets the JdbcConnectionString property

property nameOutputReference BicepOutputReference get

Gets the NameOutputReference property

property port ReferenceExpression get

Gets the Port 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) => Promise<void>): AzureSqlServerResource

Parameters

configureContainer (obj: SqlServerServerResource) => Promise<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

method withAdminDeploymentScriptSubnet builder

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

withAdminDeploymentScriptSubnet(subnet: AzureSubnetResource): AzureSqlServerResource

Parameters

subnet AzureSubnetResource

Returns

AzureSqlServerResource