AzureAppServiceEnvironmentResource

Handle

📦 Aspire.Hosting.Azure.AppService v13.4.0

interface AzureAppServiceEnvironmentResource
  extends IAzureResource,
    IComputeEnvironmentResource,
    IContainerRegistry,
    IResource,
    IResourceWithParameters,
    IAzureComputeEnvironmentResource,
    IAzureContainerRegistry {
  withAcrPullIdentity(identityBuilder: AzureUserAssignedIdentityResource): AzureAppServiceEnvironmentResource;
  withAzureApplicationInsights(applicationInsights?: AzureApplicationInsightsResource): AzureAppServiceEnvironmentResource;
  withDashboard(enable?: boolean): AzureAppServiceEnvironmentResource;
  withDeploymentSlot(deploymentSlot: ParameterResource): AzureAppServiceEnvironmentResource;
  withHttpsUpgrade(upgrade?: boolean): AzureAppServiceEnvironmentResource;
}

5 members

Methods

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

Parameters

identityBuilder AzureUserAssignedIdentityResource

Returns

AzureAppServiceEnvironmentResource

method withAzureApplicationInsights builder

Enables Azure Application Insights for the Azure App Service environment

withAzureApplicationInsights(applicationInsights?: AzureApplicationInsightsResource): AzureAppServiceEnvironmentResource

Parameters

applicationInsights AzureApplicationInsightsResource optional

Returns

AzureAppServiceEnvironmentResource

method withDashboard builder

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

withDashboard(enable?: boolean): AzureAppServiceEnvironmentResource

Parameters

enable boolean optional = True

Returns

AzureAppServiceEnvironmentResource

method withDeploymentSlot builder

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

withDeploymentSlot(deploymentSlot: ParameterResource): AzureAppServiceEnvironmentResource

Parameters

deploymentSlot ParameterResource

Returns

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

Parameters

upgrade boolean optional = True

Returns

AzureAppServiceEnvironmentResource