Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

AzureAppServiceEnvironmentResource

Handle
📦 Aspire.Hosting.Azure.AppService v17.0.0
type AzureAppServiceEnvironmentResource interface {
ComputeEnvironmentResource
Resource
}

Methods

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
identityBuilderAzureUserAssignedIdentityResourceThe resource builder for the user-assigned identity that should be used for image pulls. The supplied identity must already have the AcrPull role on the configured container registry.
AzureAppServiceEnvironmentResource

The IResourceBuilder for chaining.

Returns a handle; failures surface later via Err().

Enables Azure Application Insights for the Azure App Service environment
WithAzureApplicationInsights(options ...*WithAzureApplicationInsightsOptions) AzureAppServiceEnvironmentResource
options...*WithAzureApplicationInsightsOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithAzureApplicationInsightsOptions argument.

ApplicationInsightsany
AzureAppServiceEnvironmentResource

Returns a handle; failures surface later via Err().

methodWithDashboardbuilder
Configures whether the Aspire dashboard should be included in the Azure App Service environment.
WithDashboard(options ...*WithDashboardOptions) AzureAppServiceEnvironmentResource
options...*WithDashboardOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDashboardOptions argument.

Enable*boolWhether to include the Aspire dashboard. Default is true.
AzureAppServiceEnvironmentResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithDeploymentSlotbuilder
Configures the deployment slot for all Azure App Services in the environment
WithDeploymentSlot(deploymentSlot any) AzureAppServiceEnvironmentResource
deploymentSlotany
AzureAppServiceEnvironmentResource

Returns a handle; failures surface later via Err().

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(options ...*WithHttpsUpgradeOptions) AzureAppServiceEnvironmentResource
options...*WithHttpsUpgradeOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithHttpsUpgradeOptions argument.

Upgrade*boolWhether to upgrade HTTP endpoints to HTTPS. Default is true.
AzureAppServiceEnvironmentResource

The resource builder.

Returns a handle; failures surface later via Err().