Skip to content
Docs Try Aspire
Docs Try

Aspire.Hosting.Azure.AppService

Official
📦 Aspire.Hosting.Azure.AppService v13.4.0
10 Functions
2 Types

Types

Functions

method addAzureAppServiceEnvironment builder
Adds a azure app service environment resource to the distributed application builder.
addAzureAppServiceEnvironment(name: string): AzureAppServiceEnvironmentResource
method configureSiteConfig
Configures supported Azure App Service site settings.
configureSiteConfig(siteConfig: AzureAppServiceSiteConfig): void
method configureSlotSiteConfig
Configures supported Azure App Service deployment slot site settings.
configureSlotSiteConfig(siteConfig: AzureAppServiceSiteConfig): void
method publishAsAzureAppServiceWebsite builder
Publishes the specified compute resource as an Azure App Service or Azure App Service Slot.
publishAsAzureAppServiceWebsite(configure?: (arg1: AzureResourceInfrastructure, arg2: WebSite) => Promise<void>, configureSlot?: (arg1: AzureResourceInfrastructure, arg2: WebSiteSlot) => Promise<void>): IComputeResource
method skipEnvironmentVariableNameChecks builder
Skips validation for environment variable names that Azure App Service may not support.
skipEnvironmentVariableNameChecks(): IComputeResource
method withAcrPullIdentity builder
Configures the Azure App Service environment to use the supplied `AzureUserAssignedIdentityResource` as the managed identity that App Service apps use to pull images from the configured container registry (the `AcrPull` identity), instead of having Aspire create a new identity and a new `AcrPull` role assignment.
withAcrPullIdentity(identityBuilder: AzureUserAssignedIdentityResource): AzureAppServiceEnvironmentResource
method withAzureApplicationInsights builder
Enables Azure Application Insights for the Azure App Service environment
withAzureApplicationInsights(applicationInsights?: AzureApplicationInsightsResource): AzureAppServiceEnvironmentResource
method withDashboard builder
Configures whether the Aspire dashboard should be included in the Azure App Service environment.
withDashboard(enable?: boolean): AzureAppServiceEnvironmentResource
method withDeploymentSlot builder
Configures the deployment slot for all Azure App Services in the environment
withDeploymentSlot(deploymentSlot: ParameterResource): AzureAppServiceEnvironmentResource
method withHttpsUpgrade builder
Configures whether HTTP endpoints should be automatically upgraded to HTTPS for the Azure App Service environment. By default, HTTP endpoints are upgraded to HTTPS for security and WebSocket compatibility.
withHttpsUpgrade(upgrade?: boolean): AzureAppServiceEnvironmentResource