Aspire.Hosting.Azure.Sql
Official
📦 Aspire.Hosting.Azure.Sql v13.2.0-preview.1.26159.1 58 Functions
24 Types
24 types and 88 members
Types
handle
AzureBicepResource 9 members handle
AzureBlobStorageContainerResource handle
AzureBlobStorageResource handle
AzureDataLakeStorageFileSystemResource handle
AzureDataLakeStorageResource handle
AzureEnvironmentResource 2 members handle
AzureProvisioningResource 1 members handle
AzureQueueStorageQueueResource handle
AzureQueueStorageResource handle
AzureResourceInfrastructure 3 members handle
AzureSqlDatabaseResource 8 members handle
AzureSqlServerResource 14 members handle
AzureStorageEmulatorResource 6 members handle
AzureStorageResource 8 members handle
AzureTableStorageResource handle
AzureUserAssignedIdentityResource handle
BicepOutputReference 3 members interface
IAzureKeyVaultResource interface
IAzureKeyVaultSecretReference interface
IAzureResource 9 members handle
SqlServerDatabaseResource 7 members handle
SqlServerServerResource 18 members Functions
function
addAzureEnvironment builder Adds the shared Azure environment resource to the application model
addAzureEnvironment(): AzureEnvironmentResource function
addAzureInfrastructure builder Adds an Azure provisioning resource to the application model
addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => void): AzureProvisioningResource function
addAzureProvisioning Adds Azure provisioning services to the distributed application builder
addAzureProvisioning(): IDistributedApplicationBuilder function
addAzureSqlServer builder Adds an Azure SQL Database server resource
addAzureSqlServer(name: string): AzureSqlServerResource function
addAzureStorage builder Adds an Azure Storage resource
addAzureStorage(name: string): AzureStorageResource function
addAzureUserAssignedIdentity builder Adds an Azure user-assigned identity resource
addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource function
addBicepTemplate builder Adds an Azure Bicep template resource from a file
addBicepTemplate(name: string, bicepFile: string): AzureBicepResource function
addBicepTemplateString builder Adds an Azure Bicep template resource from inline Bicep content
addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource function
addBlobContainer builder Adds an Azure Blob Storage container resource
addBlobContainer(name: string, blobContainerName?: string): AzureBlobStorageContainerResource function
addBlobs builder Adds an Azure Blob Storage resource
addBlobs(name: string): AzureBlobStorageResource function
addDatabase builder Adds an Azure SQL database resource
addDatabase(name: string, databaseName?: string): AzureSqlDatabaseResource function
addDatabase builder Adds a SQL Server database resource
addDatabase(name: string, databaseName?: string): SqlServerDatabaseResource function
addDataLake builder Adds an Azure Data Lake Storage resource
addDataLake(name: string): AzureDataLakeStorageResource function
addDataLakeFileSystem builder Adds an Azure Data Lake Storage file system resource
addDataLakeFileSystem(name: string, dataLakeFileSystemName?: string): AzureDataLakeStorageFileSystemResource function
addQueue builder Adds an Azure Storage queue resource
addQueue(name: string, queueName?: string): AzureQueueStorageQueueResource function
addQueues builder Adds an Azure Queue Storage resource
addQueues(name: string): AzureQueueStorageResource function
addSqlServer builder Adds a SQL Server container resource
addSqlServer(name: string, password?: ParameterResource, port?: number): SqlServerServerResource function
addTables builder Adds an Azure Table Storage resource
addTables(name: string): AzureTableStorageResource function
asExisting builder Marks an Azure resource as existing in both run and publish modes
asExisting(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
clearDefaultRoleAssignments builder Clears the default Azure role assignments from a resource
clearDefaultRoleAssignments(): IAzureResource function
configureInfrastructure builder Configures the Azure provisioning infrastructure callback
configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => void): AzureProvisioningResource function
getBicepIdentifier Gets the normalized Bicep identifier for an Azure resource
getBicepIdentifier(): string function
getOutput Gets an output reference from an Azure Bicep template resource
getOutput(name: string): BicepOutputReference function
isExisting Determines whether a resource is marked as existing
isExisting(): boolean function
publishAsConnectionString builder Publishes an Azure resource to the manifest as a connection string
publishAsConnectionString(): IAzureResource function
publishAsExisting builder Marks an Azure resource as existing in publish mode
publishAsExisting(name: string, resourceGroup: string): IAzureResource function
publishAsExistingFromParameters builder Marks an Azure resource as existing in publish mode by using parameter resources
publishAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
runAsContainer builder Configures the Azure SQL server to run locally in a SQL Server container
runAsContainer(configureContainer?: (obj: SqlServerServerResource) => void): AzureSqlServerResource function
runAsEmulator builder Configures the Azure Storage resource to be emulated using Azurite
runAsEmulator(configureContainer?: (obj: AzureStorageEmulatorResource) => void): AzureStorageResource function
runAsExisting builder Marks an Azure resource as existing in run mode
runAsExisting(name: string, resourceGroup: string): IAzureResource function
runAsExistingFromParameters builder Marks an Azure resource as existing in run mode by using parameter resources
runAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
withAdminDeploymentScriptStorage builder Configures the Azure SQL server to use a specific storage account for deployment scripts
withAdminDeploymentScriptStorage(storage: AzureStorageResource): AzureSqlServerResource function
withApiVersionCheck builder Configures whether the emulator checks API version validity
withApiVersionCheck(enable?: boolean): AzureStorageEmulatorResource function
withAzureUserAssignedIdentity builder Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource function
withBlobPort builder Sets the host port for blob requests on the storage emulator
withBlobPort(port: number): AzureStorageEmulatorResource function
withCreationScript builder Defines the SQL script used to create the database
withCreationScript(script: string): SqlServerDatabaseResource function
withDataBindMount builder Adds a bind mount for the data folder to an Azure Storage emulator resource
withDataBindMount(path?: string, isReadOnly?: boolean): AzureStorageEmulatorResource function
withDataBindMount builder Adds a bind mount for the SQL Server data folder
withDataBindMount(source: string, isReadOnly?: boolean): SqlServerServerResource function
withDataVolume builder Adds a named volume for the data folder to an Azure Storage emulator resource
withDataVolume(name?: string, isReadOnly?: boolean): AzureStorageEmulatorResource function
withDataVolume builder Adds a named volume for the SQL Server data folder
withDataVolume(name?: string, isReadOnly?: boolean): SqlServerServerResource function
withDefaultAzureSku builder Configures the Azure SQL database to use the default Azure SKU
withDefaultAzureSku(): AzureSqlDatabaseResource function
withEnvironmentFromKeyVaultSecret builder Sets an environment variable from an Azure Key Vault secret reference
withEnvironmentFromKeyVaultSecret(name: string, secretReference: IAzureKeyVaultSecretReference): IResourceWithEnvironment function
withEnvironmentFromOutput builder Sets an environment variable from a Bicep output reference
withEnvironmentFromOutput(name: string, bicepOutputReference: BicepOutputReference): IResourceWithEnvironment function
withHostPort builder Sets the host port for the SQL Server resource
withHostPort(port: number): SqlServerServerResource function
withLocation builder Sets the Azure location for the shared Azure environment resource
withLocation(location: ParameterResource): AzureEnvironmentResource function
withParameter builder Adds a Bicep parameter without a value
withParameter(name: string): AzureBicepResource function
withParameterFromConnectionString builder Adds a Bicep parameter from a connection string resource builder
withParameterFromConnectionString(name: string, value: IResourceWithConnectionString): AzureBicepResource function
withParameterFromEndpoint builder Adds a Bicep parameter from an endpoint reference
withParameterFromEndpoint(name: string, value: EndpointReference): AzureBicepResource function
withParameterFromOutput builder Adds a Bicep parameter from another Bicep output reference
withParameterFromOutput(name: string, value: BicepOutputReference): AzureBicepResource function
withParameterFromParameter builder Adds a Bicep parameter from a parameter resource builder
withParameterFromParameter(name: string, value: ParameterResource): AzureBicepResource function
withParameterFromReferenceExpression builder Adds a Bicep parameter from a reference expression
withParameterFromReferenceExpression(name: string, value: ReferenceExpression): AzureBicepResource function
withParameterStringValue builder Adds a Bicep parameter with a string value
withParameterStringValue(name: string, value: string): AzureBicepResource function
withParameterStringValues builder Adds a Bicep parameter with a string list value
withParameterStringValues(name: string, value: string[]): AzureBicepResource function
withPassword builder Configures the password for the SQL Server resource
withPassword(password: ParameterResource): SqlServerServerResource function
withQueuePort builder Sets the host port for queue requests on the storage emulator
withQueuePort(port: number): AzureStorageEmulatorResource function
withResourceGroup builder Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource function
withStorageRoleAssignments builder Assigns Azure Storage roles to a resource
withStorageRoleAssignments(target: AzureStorageResource, roles: AzureStorageRole[]): IResource function
withTablePort builder Sets the host port for table requests on the storage emulator
withTablePort(port: number): AzureStorageEmulatorResource