Aspire.Hosting.Azure.AppContainers
Official
📦 Aspire.Hosting.Azure.AppContainers v13.2.0 49 Functions
16 Types
16 types and 6 members
Types
handle
AzureBicepResource 9 members handle
AzureContainerAppEnvironmentResource 5 members handle
AzureContainerRegistryResource 1 members handle
AzureEnvironmentResource 2 members handle
AzureLogAnalyticsWorkspaceResource handle
AzureProvisioningResource 1 members handle
AzureResourceInfrastructure 3 members handle
AzureUserAssignedIdentityResource handle
BicepOutputReference 3 members handle
ContainerApp handle
ContainerAppJob interface
IAzureKeyVaultResource interface
IAzureKeyVaultSecretReference interface
IAzureResource 9 members Functions
method
addAzureContainerAppEnvironment builder Adds an Azure Container App Environment resource
addAzureContainerAppEnvironment(name: string): AzureContainerAppEnvironmentResource method
addAzureContainerRegistry builder Adds an Azure Container Registry resource to the distributed application model.
addAzureContainerRegistry(name: string): AzureContainerRegistryResource 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
addAzureLogAnalyticsWorkspace builder Adds an Azure Log Analytics Workspace resource
addAzureLogAnalyticsWorkspace(name: string): AzureLogAnalyticsWorkspaceResource 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
getAzureContainerRegistry builder Gets the Azure Container Registry associated with a compute environment resource.
getAzureContainerRegistry(): AzureContainerRegistryResource 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
publishAsAzureContainerApp builder Configures the container resource to be published as an Azure Container App
publishAsAzureContainerApp(configure: (arg1: AzureResourceInfrastructure, arg2: ContainerApp) => Promise<void>): ContainerResource method
publishAsAzureContainerApp builder Configures the executable resource to be published as an Azure Container App
publishAsAzureContainerApp(configure: (arg1: AzureResourceInfrastructure, arg2: ContainerApp) => Promise<void>): ExecutableResource method
publishAsAzureContainerApp builder Configures the project resource to be published as an Azure Container App
publishAsAzureContainerApp(configure: (arg1: AzureResourceInfrastructure, arg2: ContainerApp) => Promise<void>): ProjectResource method
publishAsAzureContainerAppJob builder Configures the compute resource as a manually triggered Azure Container App Job
publishAsAzureContainerAppJob(): IComputeResource method
publishAsConfiguredAzureContainerAppJob builder Configures the compute resource as an Azure Container App Job with custom configuration
publishAsConfiguredAzureContainerAppJob(configure: (arg1: AzureResourceInfrastructure, arg2: ContainerAppJob) => Promise<void>): IComputeResource method
publishAsConfiguredScheduledAzureContainerAppJob builder Configures the compute resource as a scheduled Azure Container App Job with custom configuration
publishAsConfiguredScheduledAzureContainerAppJob(cronExpression: string, configure?: (arg1: AzureResourceInfrastructure, arg2: ContainerAppJob) => Promise<void>): IComputeResource 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
publishAsScheduledAzureContainerAppJob builder Configures the compute resource as a scheduled Azure Container App Job
publishAsScheduledAzureContainerAppJob(cronExpression: string): IComputeResource 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
withAzdResourceNaming builder Configures resources to use azd naming conventions
withAzdResourceNaming(): AzureContainerAppEnvironmentResource method
withAzureContainerRegistry builder Configures a compute environment resource to use an Azure Container Registry.
withAzureContainerRegistry(registryBuilder: AzureContainerRegistryResource): IResource method
withAzureLogAnalyticsWorkspace builder Configures the container app environment to use a specific Log Analytics Workspace
withAzureLogAnalyticsWorkspace(workspaceBuilder: AzureLogAnalyticsWorkspaceResource): AzureContainerAppEnvironmentResource method
withAzureUserAssignedIdentity builder Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource method
withCompactResourceNaming builder Configures resources to use compact naming for length-constrained Azure resources
withCompactResourceNaming(): AzureContainerAppEnvironmentResource method
withContainerRegistryRoleAssignments builder Assigns Azure Container Registry roles to a resource.
withContainerRegistryRoleAssignments(target: AzureContainerRegistryResource, roles: AzureContainerRegistryRole[]): IResource method
withDashboard builder Configures whether the Aspire dashboard is included in the container app environment
withDashboard(enable?: boolean): AzureContainerAppEnvironmentResource 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
withHttpsUpgrade builder Configures whether HTTP endpoints are upgraded to HTTPS
withHttpsUpgrade(upgrade?: boolean): AzureContainerAppEnvironmentResource 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
withPurgeTask builder Configures a purge task for the Azure Container Registry resource.
withPurgeTask(schedule: string, filter?: string, ago?: timespan, keep?: number, taskName?: string): AzureContainerRegistryResource method
withResourceGroup builder Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource