Aspire.Hosting.Azure

Official

📦 Aspire.Hosting.Azurev13.6.0

28Functions

9Types

9 types and 3 members

Types

handleAzureBicepResource2 members

handleAzureEnvironmentResource2 members

handleAzureProvisioningResource1 members

handleAzureResourceInfrastructure

handleAzureUserAssignedIdentityResource

handleBicepOutputReference3 members

interfaceIAzureKeyVaultResource

interfaceIAzureKeyVaultSecretReference

interfaceIAzureResource16 members

Functions

methodaddAzureEnvironmentbuilder

Adds an Azure environment resource to the application model.

addAzureEnvironment(): AzureEnvironmentResource

methodaddAzureInfrastructurebuilder

Adds an Azure provisioning resource to the application model.

addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource

methodaddAzureProvisioning

Adds support for generating Azure resources dynamically during application startup. The application must configure the appropriate Azure subscription and location before resources can be provisioned.

addAzureProvisioning(): IDistributedApplicationBuilder

methodaddAzureUserAssignedIdentitybuilder

Adds an Azure user‑assigned identity resource to the application model.

addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource

methodaddBicepTemplatebuilder

Adds an Azure Bicep resource to the application model.

addBicepTemplate(name: string, bicepFile: string): AzureBicepResource

methodaddBicepTemplateStringbuilder

Adds an Azure Bicep resource to the application model.

addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource

methodasExistingbuilder

Marks the resource as an existing resource in both run and publish modes.

asExisting(name: string | ParameterResource, resourceGroup?: string | ParameterResource): IAzureResource

methodasExistingInResourceGroupbuilder

Marks the resource as an existing resource in a specific resource group and subscription in both run and publish modes.

asExistingInResourceGroup(name: string | ParameterResource, resourceGroup: string | ParameterResource, subscription: string | ParameterResource): IAzureResource

methodasExistingInSubscriptionbuilder

Marks the subscription-scoped resource as an existing resource in both run and publish modes.

asExistingInSubscription(name: string | ParameterResource, subscription: string | ParameterResource): IAzureResource

methodasExistingInTenantbuilder

Marks the current-tenant-scoped resource as an existing resource in both run and publish modes.

asExistingInTenant(name: string | ParameterResource): IAzureResource

methodclearDefaultRoleAssignmentsbuilder

Clears all default role assignments for the specified Azure resource.

clearDefaultRoleAssignments(): IAzureResource

methodconfigureInfrastructurebuilder

Configures the Azure provisioning infrastructure callback

configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource

methodgetBicepIdentifier

Gets the Bicep identifier for the Azure resource.

getBicepIdentifier(): string

methodgetOutput

Gets a reference to an output from a bicep template.

getOutput(name: string): BicepOutputReference

methodisExisting

Determines whether the Azure resource is marked as existing.

isExisting(): boolean

methodpublishAsConnectionStringbuilder

Changes the resource to be published as a connection string reference in the manifest.

publishAsConnectionString(): IAzureResource

methodpublishAsExistingbuilder

Marks the resource as an existing resource when the application is deployed.

publishAsExisting(name: string | ParameterResource, resourceGroup?: string | ParameterResource): IAzureResource

methodpublishAsExistingInResourceGroupbuilder

Marks the resource as an existing resource in a specific resource group and subscription when the application is deployed.

publishAsExistingInResourceGroup(name: string | ParameterResource, resourceGroup: string | ParameterResource, subscription: string | ParameterResource): IAzureResource

methodpublishAsExistingInSubscriptionbuilder

Marks the subscription-scoped resource as an existing resource when the application is deployed.

publishAsExistingInSubscription(name: string | ParameterResource, subscription: string | ParameterResource): IAzureResource

methodpublishAsExistingInTenantbuilder

Marks the current-tenant-scoped resource as an existing resource when the application is deployed.

publishAsExistingInTenant(name: string | ParameterResource): IAzureResource

methodrunAsExistingbuilder

Marks the resource as an existing resource when the application is running.

runAsExisting(name: string | ParameterResource, resourceGroup?: string | ParameterResource): IAzureResource

methodrunAsExistingInResourceGroupbuilder

Marks the resource as an existing resource in a specific resource group and subscription when the application is running.

runAsExistingInResourceGroup(name: string | ParameterResource, resourceGroup: string | ParameterResource, subscription: string | ParameterResource): IAzureResource

methodrunAsExistingInSubscriptionbuilder

Marks the subscription-scoped resource as an existing resource when the application is running.

runAsExistingInSubscription(name: string | ParameterResource, subscription: string | ParameterResource): IAzureResource

methodrunAsExistingInTenantbuilder

Marks the current-tenant-scoped resource as an existing resource when the application is running.

runAsExistingInTenant(name: string | ParameterResource): IAzureResource

methodwithAzureUserAssignedIdentitybuilder

Associates an Azure user-assigned identity with a compute resource

withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource

methodwithLocationbuilder

Sets the location of the Azure environment resource.

withLocation(location: ParameterResource): AzureEnvironmentResource

methodwithParameterbuilder

Adds a Bicep parameter

withParameter(name: string, value?: string | string[] | ParameterResource | IResourceWithConnectionString | BicepOutputReference | ReferenceExpression | EndpointReference): AzureBicepResource

methodwithResourceGroupbuilder

Sets the resource group name of the Azure environment resource.

withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource