Skip to content
Docs Try Aspire
Docs Try

Aspire.Hosting.Azure.AppConfiguration

Official
📦 Aspire.Hosting.Azure.AppConfiguration v13.2.0
36 Functions
13 Types

Types

Functions

method addAzureAppConfiguration builder
Adds an Azure App Configuration resource
addAzureAppConfiguration(name: string): AzureAppConfigurationResource
method addAzureEnvironment builder
Adds the shared Azure environment resource to the application model
addAzureEnvironment(): AzureEnvironmentResource
method addAzureInfrastructure builder
Adds an Azure provisioning resource to the application model
addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource
method addAzureProvisioning
Adds Azure provisioning services to the distributed application builder
addAzureProvisioning(): IDistributedApplicationBuilder
method addAzureUserAssignedIdentity builder
Adds an Azure user-assigned identity resource
addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource
method addBicepTemplate builder
Adds an Azure Bicep template resource from a file
addBicepTemplate(name: string, bicepFile: string): AzureBicepResource
method addBicepTemplateString builder
Adds an Azure Bicep template resource from inline Bicep content
addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource
method asExisting builder
Marks an Azure resource as existing in both run and publish modes by using parameter resources
asExisting(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource
method clearDefaultRoleAssignments builder
Clears the default Azure role assignments from a resource
clearDefaultRoleAssignments(): IAzureResource
method configureInfrastructure builder
Configures the Azure provisioning infrastructure callback
configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource
method getBicepIdentifier
Gets the normalized Bicep identifier for an Azure resource
getBicepIdentifier(): string
method getOutput
Gets an output reference from an Azure Bicep template resource
getOutput(name: string): BicepOutputReference
method isExisting
Determines whether a resource is marked as existing
isExisting(): boolean
method publishAsConnectionString builder
Publishes an Azure resource to the manifest as a connection string
publishAsConnectionString(): IAzureResource
method publishAsExisting builder
Marks an Azure resource as existing in publish mode
publishAsExisting(name: string, resourceGroup: string): IAzureResource
method publishAsExistingFromParameters builder
Marks an Azure resource as existing in publish mode by using parameter resources
publishAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource
method runAsEmulator builder
Configures Azure App Configuration to run with the local emulator
runAsEmulator(configureEmulator?: (obj: AzureAppConfigurationEmulatorResource) => Promise<void>): AzureAppConfigurationResource
method runAsExisting builder
Marks an Azure resource as existing in run mode
runAsExisting(name: string, resourceGroup: string): IAzureResource
method runAsExistingFromParameters builder
Marks an Azure resource as existing in run mode by using parameter resources
runAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource
method withAppConfigurationRoleAssignments builder
Assigns App Configuration roles to a resource
withAppConfigurationRoleAssignments(target: AzureAppConfigurationResource, roles: AzureAppConfigurationRole[]): IResource
method withAzureUserAssignedIdentity builder
Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource
method withDataBindMount builder
Adds a data bind mount for the App Configuration emulator
withDataBindMount(path?: string): AzureAppConfigurationEmulatorResource
method withDataVolume builder
Adds a data volume for the App Configuration emulator
withDataVolume(name?: string): AzureAppConfigurationEmulatorResource
method withEnvironmentFromKeyVaultSecret builder
Sets an environment variable from an Azure Key Vault secret reference
withEnvironmentFromKeyVaultSecret(name: string, secretReference: IAzureKeyVaultSecretReference): IResourceWithEnvironment
method withEnvironmentFromOutput builder
Sets an environment variable from a Bicep output reference
withEnvironmentFromOutput(name: string, bicepOutputReference: BicepOutputReference): IResourceWithEnvironment
method withHostPort builder
Sets the host port for the App Configuration emulator
withHostPort(port: number): AzureAppConfigurationEmulatorResource
method withLocation builder
Sets the Azure location for the shared Azure environment resource
withLocation(location: ParameterResource): AzureEnvironmentResource
method withParameter builder
Adds a Bicep parameter without a value
withParameter(name: string): AzureBicepResource
method withParameterFromConnectionString builder
Adds a Bicep parameter from a connection string resource builder
withParameterFromConnectionString(name: string, value: IResourceWithConnectionString): AzureBicepResource
method withParameterFromEndpoint builder
Adds a Bicep parameter from an endpoint reference
withParameterFromEndpoint(name: string, value: EndpointReference): AzureBicepResource
method withParameterFromOutput builder
Adds a Bicep parameter from another Bicep output reference
withParameterFromOutput(name: string, value: BicepOutputReference): AzureBicepResource
method withParameterFromParameter builder
Adds a Bicep parameter from a parameter resource builder
withParameterFromParameter(name: string, value: ParameterResource): AzureBicepResource
method withParameterFromReferenceExpression builder
Adds a Bicep parameter from a reference expression
withParameterFromReferenceExpression(name: string, value: ReferenceExpression): AzureBicepResource
method withParameterStringValue builder
Adds a Bicep parameter with a string value
withParameterStringValue(name: string, value: string): AzureBicepResource
method withParameterStringValues builder
Adds a Bicep parameter with a string list value
withParameterStringValues(name: string, value: string[]): AzureBicepResource
method withResourceGroup builder
Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource

Enums