Aspire.Hosting.Azure
Official
📦 Aspire.Hosting.Azurev17.0.0Import path
apphost/modules/aspire28Functions
9Types
9 types, 28 functions and 3 members
Handles
handle
AzureBicepResource2 membershandle
AzureEnvironmentResource2 membersinterface
AzureKeyVaultResourcemarkerinterface
AzureKeyVaultSecretReferencemarkerhandle
AzureProvisioningResource1 membersinterface
AzureResourcemarker16 membershandle
AzureResourceInfrastructurehandle
AzureUserAssignedIdentityResourcehandle
BicepOutputReference3 membersFunctions
AzureBicepResource
AzureEnvironmentResource
method
WithLocationbuilderSets the location of the Azure environment resource.
WithLocation(location ParameterResource) AzureEnvironmentResourcemethod
WithResourceGroupbuilderSets the resource group name of the Azure environment resource.
WithResourceGroup(resourceGroup ParameterResource) AzureEnvironmentResourceAzureProvisioningResource
AzureResource
method
AsExistingbuilderMarks the resource as an existing resource in both run and publish modes.
AsExisting(name any, options ...*AsExistingOptions) AzureResourcemethod
AsExistingInResourceGroupbuilderMarks the resource as an existing resource in a specific resource group and subscription in both run and publish modes.
AsExistingInResourceGroup(name any, resourceGroup any, subscription any) AzureResourcemethod
AsExistingInSubscriptionbuilderMarks the subscription-scoped resource as an existing resource in both run and publish modes.
AsExistingInSubscription(name any, subscription any) AzureResourcemethod
AsExistingInTenantbuilderMarks the current-tenant-scoped resource as an existing resource in both run and publish modes.
AsExistingInTenant(name any) AzureResourcemethod
ClearDefaultRoleAssignmentsbuilderClears all default role assignments for the specified Azure resource.
ClearDefaultRoleAssignments() AzureResourcemethod
GetBicepIdentifierGets the Bicep identifier for the Azure resource.
GetBicepIdentifier() (string, error)method
IsExistingDetermines whether the Azure resource is marked as existing.
IsExisting() (bool, error)method
PublishAsConnectionStringbuilderChanges the resource to be published as a connection string reference in the manifest.
PublishAsConnectionString() AzureResourcemethod
PublishAsExistingbuilderMarks the resource as an existing resource when the application is deployed.
PublishAsExisting(name any, options ...*PublishAsExistingOptions) AzureResourcemethod
PublishAsExistingInResourceGroupbuilderMarks the resource as an existing resource in a specific resource group and subscription when the application is deployed.
PublishAsExistingInResourceGroup(name any, resourceGroup any, subscription any) AzureResourcemethod
PublishAsExistingInSubscriptionbuilderMarks the subscription-scoped resource as an existing resource when the application is deployed.
PublishAsExistingInSubscription(name any, subscription any) AzureResourcemethod
PublishAsExistingInTenantbuilderMarks the current-tenant-scoped resource as an existing resource when the application is deployed.
PublishAsExistingInTenant(name any) AzureResourcemethod
RunAsExistingbuilderMarks the resource as an existing resource when the application is running.
RunAsExisting(name any, options ...*RunAsExistingOptions) AzureResourcemethod
RunAsExistingInResourceGroupbuilderMarks the resource as an existing resource in a specific resource group and subscription when the application is running.
RunAsExistingInResourceGroup(name any, resourceGroup any, subscription any) AzureResourcemethod
RunAsExistingInSubscriptionbuilderMarks the subscription-scoped resource as an existing resource when the application is running.
RunAsExistingInSubscription(name any, subscription any) AzureResourcemethod
RunAsExistingInTenantbuilderMarks the current-tenant-scoped resource as an existing resource when the application is running.
RunAsExistingInTenant(name any) AzureResourceDistributedApplicationBuilder
method
AddAzureEnvironmentbuilderAdds an Azure environment resource to the application model.
AddAzureEnvironment() AzureEnvironmentResourcemethod
AddAzureInfrastructurebuilderAdds an Azure provisioning resource to the application model.
AddAzureInfrastructure(name string, configureInfrastructure func(obj AzureResourceInfrastructure)) AzureProvisioningResourcemethod
AddAzureProvisioningAdds 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() DistributedApplicationBuildermethod
AddAzureUserAssignedIdentitybuilderAdds an Azure user‑assigned identity resource to the application model.
AddAzureUserAssignedIdentity(name string) AzureUserAssignedIdentityResourcemethod
AddBicepTemplatebuilderAdds an Azure Bicep resource to the application model.
AddBicepTemplate(name string, bicepFile string) AzureBicepResourcemethod
AddBicepTemplateStringbuilderAdds an Azure Bicep resource to the application model.
AddBicepTemplateString(name string, bicepContent string) AzureBicepResourceExported values
AzureSubnetServiceDelegations.AppServiceEnvironmentsstring= "Microsoft.Web/serverFarms"Delegation for Azure App Service environments.
AzureSubnetServiceDelegations.ApplicationGatewayForContainersstring= "Microsoft.ServiceNetworking/trafficControllers"Delegation for Azure Application Gateway for Containers.
AzureSubnetServiceDelegations.ContainerAppEnvironmentsstring= "Microsoft.App/environments"Delegation for Azure Container Apps environments.
AzureSubnetServiceDelegations.ContainerInstancesstring= "Microsoft.ContainerInstance/containerGroups"Delegation for Azure Container Instances (ACI), which allows container groups to be deployed into the subnet.