Aspire.Hosting.Azure.AppService

Docs/Reference/Search TypeScript APIs/Aspire.Hosting.Azure.AppService

Aspire.Hosting.Azure.AppService

Docs Reference Search TypeScript APIs Aspire.Hosting.Azure.AppService

Official

📦 Aspire.Hosting.Azure.AppServicev13.4.0

10Functions

2Types

Search types, functions, members in Aspire.Hosting.Azure.AppService...

handlemethodtype

2 types and 0 membersClear filters

Types

handleAzureAppServiceEnvironmentResource5 members

typeAzureAppServiceSiteConfig1 fields

Functions

methodaddAzureAppServiceEnvironmentbuilder

Adds a azure app service environment resource to the distributed application builder.

addAzureAppServiceEnvironment(name: string): AzureAppServiceEnvironmentResource

methodconfigureSiteConfig

Configures supported Azure App Service site settings.

configureSiteConfig(siteConfig: AzureAppServiceSiteConfig): void

methodconfigureSlotSiteConfig

Configures supported Azure App Service deployment slot site settings.

configureSlotSiteConfig(siteConfig: AzureAppServiceSiteConfig): void

methodpublishAsAzureAppServiceWebsitebuilder

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

methodskipEnvironmentVariableNameChecksbuilder

Skips validation for environment variable names that Azure App Service may not support.

skipEnvironmentVariableNameChecks(): IComputeResource

methodwithAcrPullIdentitybuilder

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

methodwithAzureApplicationInsightsbuilder

Enables Azure Application Insights for the Azure App Service environment

withAzureApplicationInsights(applicationInsights?: AzureApplicationInsightsResource): AzureAppServiceEnvironmentResource

methodwithDashboardbuilder

Configures whether the Aspire dashboard should be included in the Azure App Service environment.

withDashboard(enable?: boolean): AzureAppServiceEnvironmentResource

methodwithDeploymentSlotbuilder

Configures the deployment slot for all Azure App Services in the environment

withDeploymentSlot(deploymentSlot: ParameterResource): AzureAppServiceEnvironmentResource

methodwithHttpsUpgradebuilder

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