swagger: '2.0' info: title: WebApps API Client AppServiceEnvironments API version: '2025-05-01' x-typespec-generated: - emitter: '@azure-tools/typespec-autorest' host: management.azure.com schemes: - https consumes: - application/json produces: - application/json security: - azure_auth: - user_impersonation tags: - name: AppServiceEnvironments paths: /subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments: get: operationId: AppServiceEnvironments_List tags: - AppServiceEnvironments summary: Get all App Service Environments for a subscription. description: Description for Get all App Service Environments for a subscription. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/AppServiceEnvironmentCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get all App Service Environments for a subscription.: $ref: ./examples/AppServiceEnvironments_List.json x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments: get: operationId: AppServiceEnvironments_ListByResourceGroup tags: - AppServiceEnvironments summary: Get all App Service Environments in a resource group. description: Description for Get all App Service Environments in a resource group. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/AppServiceEnvironmentCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get all App Service Environments in a resource group.: $ref: ./examples/AppServiceEnvironments_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}: get: operationId: AppServiceEnvironments_Get tags: - AppServiceEnvironments summary: Get the properties of an App Service Environment. description: Description for Get the properties of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/AppServiceEnvironmentResource' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get the properties of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_Get.json put: operationId: AppServiceEnvironments_CreateOrUpdate tags: - AppServiceEnvironments summary: Create or update an App Service Environment. description: Description for Create or update an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: hostingEnvironmentEnvelope in: body description: Configuration details of the App Service Environment. required: true schema: $ref: '#/definitions/AppServiceEnvironmentResource' responses: '200': description: Resource 'AppServiceEnvironmentResource' update operation succeeded schema: $ref: '#/definitions/AppServiceEnvironmentResource' '201': description: Resource 'AppServiceEnvironmentResource' create operation succeeded schema: $ref: '#/definitions/AppServiceEnvironmentResource' headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. '202': description: The request has been accepted for processing, but processing has not yet completed. schema: $ref: '#/definitions/AppServiceEnvironmentResource' headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Create or update an App Service Environment.: $ref: ./examples/AppServiceEnvironments_CreateOrUpdate.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/AppServiceEnvironmentResource' x-ms-long-running-operation: true patch: operationId: AppServiceEnvironments_Update tags: - AppServiceEnvironments summary: Create or update an App Service Environment. description: Description for Create or update an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: hostingEnvironmentEnvelope in: body description: Configuration details of the App Service Environment. required: true schema: $ref: '#/definitions/AppServiceEnvironmentPatchResource' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/AppServiceEnvironmentResource' '201': description: Resource 'AppServiceEnvironmentResource' create operation succeeded schema: $ref: '#/definitions/AppServiceEnvironmentResource' '202': description: The request has been accepted for processing, but processing has not yet completed. schema: $ref: '#/definitions/AppServiceEnvironmentResource' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Create or update an App Service Environment.: $ref: ./examples/AppServiceEnvironments_Update.json delete: operationId: AppServiceEnvironments_Delete tags: - AppServiceEnvironments summary: Delete an App Service Environment. description: Description for Delete an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: forceDelete in: query description: Specify true to force the deletion even if the App Service Environment contains resources. The default is false. required: false type: boolean responses: '202': description: Resource deletion accepted. headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. '204': description: Resource does not exist. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Delete an App Service Environment.: $ref: ./examples/AppServiceEnvironments_Delete.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute : get: operationId: AppServiceEnvironments_ListCapacities tags: - AppServiceEnvironments summary: Get the used, available, and total worker capacity an App Service Environment. description: Description for Get the used, available, and total worker capacity an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/StampCapacityCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get the used, available, and total worker capacity an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListCapacities.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip : get: operationId: AppServiceEnvironments_GetVipInfo tags: - AppServiceEnvironments summary: Get IP addresses assigned to an App Service Environment. description: Description for Get IP addresses assigned to an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/AddressResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get IP addresses assigned to an App Service Environment.: $ref: ./examples/AppServiceEnvironments_GetVipInfo.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork : post: operationId: AppServiceEnvironments_ChangeVnet tags: - AppServiceEnvironments summary: Move an App Service Environment to a different VNET. description: Description for Move an App Service Environment to a different VNET. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: vnetInfo in: body description: Details for the new virtual network. required: true schema: $ref: '#/definitions/VirtualNetworkProfile' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/WebAppCollection' '202': description: The request has been accepted for processing, but processing has not yet completed. schema: $ref: '#/definitions/WebAppCollection' headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Move an App Service Environment to a different VNET.: $ref: ./examples/AppServiceEnvironments_ChangeVnet.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/WebAppCollection' x-ms-long-running-operation: true x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix : get: operationId: AppServiceEnvironments_GetAseCustomDnsSuffixConfiguration tags: - AppServiceEnvironments summary: Get Custom Dns Suffix configuration of an App Service Environment description: Get Custom Dns Suffix configuration of an App Service Environment parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/CustomDnsSuffixConfiguration' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get ASE custom DNS suffix configuration: $ref: ./examples/GetAseCustomDnsSuffixConfiguration.json put: operationId: AppServiceEnvironments_UpdateAseCustomDnsSuffixConfiguration tags: - AppServiceEnvironments summary: Update Custom Dns Suffix configuration of an App Service Environment description: Update Custom Dns Suffix configuration of an App Service Environment parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: customDnsSuffixConfiguration in: body description: '' required: true schema: $ref: '#/definitions/CustomDnsSuffixConfiguration' responses: '200': description: Resource 'CustomDnsSuffixConfiguration' update operation succeeded schema: $ref: '#/definitions/CustomDnsSuffixConfiguration' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Update ASE custom DNS suffix configuration: $ref: ./examples/UpdateAseCustomDnsSuffixConfiguration.json delete: operationId: AppServiceEnvironments_DeleteAseCustomDnsSuffixConfiguration tags: - AppServiceEnvironments summary: Delete Custom Dns Suffix configuration of an App Service Environment description: Delete Custom Dns Suffix configuration of an App Service Environment parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: {} '204': description: 'There is no content to send for this request, but the headers may be useful. ' schema: {} default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Delete ASE custom DNS suffix configuration: $ref: ./examples/DeleteAseCustomDnsSuffixConfiguration.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking : get: operationId: AppServiceEnvironments_GetAseV3NetworkingConfiguration tags: - AppServiceEnvironments summary: Get networking configuration of an App Service Environment description: Description for Get networking configuration of an App Service Environment parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/AseV3NetworkingConfiguration' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get networking configuration of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_GetAseV3NetworkingConfiguration.json put: operationId: AppServiceEnvironments_UpdateAseNetworkingConfiguration tags: - AppServiceEnvironments summary: Update networking configuration of an App Service Environment description: Description for Update networking configuration of an App Service Environment parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: aseNetworkingConfiguration in: body description: '' required: true schema: $ref: '#/definitions/AseV3NetworkingConfiguration' responses: '200': description: Resource 'AseV3NetworkingConfiguration' update operation succeeded schema: $ref: '#/definitions/AseV3NetworkingConfiguration' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Update networking configuration of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_UpdateAseNetworkingConfiguration.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics : get: operationId: AppServiceEnvironments_ListDiagnostics tags: - AppServiceEnvironments summary: Get diagnostic information for an App Service Environment. description: Description for Get diagnostic information for an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: type: array items: $ref: '#/definitions/HostingEnvironmentDiagnostics' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get diagnostic information for an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListDiagnostics.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints : get: operationId: AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints tags: - AppServiceEnvironments summary: Get the network endpoints of all inbound dependencies of an App Service Environment. description: Description for Get the network endpoints of all inbound dependencies of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/InboundEnvironmentEndpointCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get the network endpoints of all inbound dependencies of an App Service Environment.: $ref: ./examples/GetInboundNetworkDependenciesEndpoints.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools : get: operationId: AppServiceEnvironments_ListMultiRolePools tags: - AppServiceEnvironments summary: Get all multi-role pools. description: Description for Get all multi-role pools. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/WorkerPoolCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get all multi-role pools.: $ref: ./examples/AppServiceEnvironments_ListMultiRolePools.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default : get: operationId: AppServiceEnvironments_GetMultiRolePool tags: - AppServiceEnvironments summary: Get properties of a multi-role pool. description: Description for Get properties of a multi-role pool. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/WorkerPoolResource' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get properties of a multi-role pool.: $ref: ./examples/AppServiceEnvironments_GetMultiRolePool.json put: operationId: AppServiceEnvironments_CreateOrUpdateMultiRolePool tags: - AppServiceEnvironments summary: Create or update a multi-role pool. description: Description for Create or update a multi-role pool. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: multiRolePoolEnvelope in: body description: Properties of the multi-role pool. required: true schema: $ref: '#/definitions/WorkerPoolResource' responses: '200': description: Resource 'WorkerPoolResource' update operation succeeded schema: $ref: '#/definitions/WorkerPoolResource' '202': description: The request has been accepted for processing, but processing has not yet completed. schema: $ref: '#/definitions/WorkerPoolResource' headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Create or update a multi-role pool.: $ref: ./examples/AppServiceEnvironments_CreateOrUpdateMultiRolePool.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/WorkerPoolResource' x-ms-long-running-operation: true patch: operationId: AppServiceEnvironments_UpdateMultiRolePool tags: - AppServiceEnvironments summary: Create or update a multi-role pool. description: Description for Create or update a multi-role pool. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: multiRolePoolEnvelope in: body description: Properties of the multi-role pool. required: true schema: $ref: '#/definitions/WorkerPoolResource' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/WorkerPoolResource' '202': description: The request has been accepted for processing, but processing has not yet completed. schema: $ref: '#/definitions/WorkerPoolResource' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Create or update a multi-role pool.: $ref: ./examples/AppServiceEnvironments_CreateOrUpdateMultiRolePool_UpdateMultiRolePool.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions : get: operationId: AppServiceEnvironments_ListMultiRoleMetricDefinitions tags: - AppServiceEnvironments summary: Get metric definitions for a multi-role pool of an App Service Environment. description: Description for Get metric definitions for a multi-role pool of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/ResourceMetricDefinitionCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get metric definitions for a multi-role pool of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListMultiRoleMetricDefinitions.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus : get: operationId: AppServiceEnvironments_ListMultiRolePoolSkus tags: - AppServiceEnvironments summary: Get available SKUs for scaling a multi-role pool. description: Description for Get available SKUs for scaling a multi-role pool. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/SkuInfoCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get available SKUs for scaling a multi-role pool.: $ref: ./examples/AppServiceEnvironments_ListMultiRolePoolSkus.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages : get: operationId: AppServiceEnvironments_ListMultiRoleUsages tags: - AppServiceEnvironments summary: Get usage metrics for a multi-role pool of an App Service Environment. description: Description for Get usage metrics for a multi-role pool of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/UsageCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get usage metrics for a multi-role pool of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListMultiRoleUsages.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations : get: operationId: AppServiceEnvironments_ListOperations tags: - AppServiceEnvironments summary: List all currently running operations on the App Service Environment. description: Description for List all currently running operations on the App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: type: array items: $ref: '#/definitions/Operation' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: List all currently running operations on the App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListOperations.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints : get: operationId: AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints tags: - AppServiceEnvironments summary: Get the network endpoints of all outbound dependencies of an App Service Environment. description: Description for Get the network endpoints of all outbound dependencies of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/OutboundEnvironmentEndpointCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get the network endpoints of all outbound dependencies of an App Service Environment.: $ref: ./examples/GetOutboundNetworkDependenciesEndpoints.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections : get: operationId: AppServiceEnvironments_GetPrivateEndpointConnectionList tags: - AppServiceEnvironments summary: Gets the list of private endpoints associated with a hosting environment description: Description for Gets the list of private endpoints associated with a hosting environment parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/PrivateEndpointConnectionCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Gets the list of private endpoints associated with a hosting environment.: $ref: ./examples/AppServiceEnvironments_GetPrivateEndpointConnectionList.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName} : get: operationId: AppServiceEnvironments_GetPrivateEndpointConnection tags: - AppServiceEnvironments summary: Gets a private endpoint connection description: Description for Gets a private endpoint connection parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/RemotePrivateEndpointConnectionARMResource' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Gets a private endpoint connection.: $ref: ./examples/AppServiceEnvironments_GetPrivateEndpointConnection.json put: operationId: AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection tags: - AppServiceEnvironments summary: Approves or rejects a private endpoint connection description: Description for Approves or rejects a private endpoint connection parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true type: string - name: privateEndpointWrapper in: body description: '' required: true schema: $ref: '#/definitions/RemotePrivateEndpointConnectionARMResource' responses: '200': description: Resource 'RemotePrivateEndpointConnectionARMResource' update operation succeeded schema: $ref: '#/definitions/RemotePrivateEndpointConnectionARMResource' '202': description: The request has been accepted for processing, but processing has not yet completed. schema: $ref: '#/definitions/RemotePrivateEndpointConnectionARMResource' headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Approves or rejects a private endpoint connection.: $ref: ./examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/RemotePrivateEndpointConnectionARMResource' x-ms-long-running-operation: true delete: operationId: AppServiceEnvironments_DeletePrivateEndpointConnection tags: - AppServiceEnvironments summary: Deletes a private endpoint connection description: Description for Deletes a private endpoint connection parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true type: string responses: '200': description: Azure operation completed successfully. schema: {} '202': description: The request has been accepted for processing, but processing has not yet completed. schema: {} headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. '204': description: 'There is no content to send for this request, but the headers may be useful. ' schema: {} default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Deletes a private endpoint connection.: $ref: ./examples/AppServiceEnvironments_DeletePrivateEndpointConnection.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources : get: operationId: AppServiceEnvironments_GetPrivateLinkResources tags: - AppServiceEnvironments summary: Gets the private link resources description: Description for Gets the private link resources parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/PrivateLinkResourcesWrapper' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Gets the private link resources.: $ref: ./examples/AppServiceEnvironments_GetPrivateLinkResources.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot : post: operationId: AppServiceEnvironments_Reboot tags: - AppServiceEnvironments summary: Reboot all machines in an App Service Environment. description: Description for Reboot all machines in an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '202': description: The request has been accepted for processing, but processing has not yet completed. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Reboot all machines in an App Service Environment.: $ref: ./examples/AppServiceEnvironments_Reboot.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume : post: operationId: AppServiceEnvironments_Resume tags: - AppServiceEnvironments summary: Resume an App Service Environment. description: Description for Resume an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/WebAppCollection' '202': description: The request has been accepted for processing, but processing has not yet completed. schema: $ref: '#/definitions/WebAppCollection' headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Resume an App Service Environment.: $ref: ./examples/AppServiceEnvironments_Resume.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/WebAppCollection' x-ms-long-running-operation: true x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms : get: operationId: AppServiceEnvironments_ListAppServicePlans tags: - AppServiceEnvironments summary: Get all App Service plans in an App Service Environment. description: Description for Get all App Service plans in an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/AppServicePlanCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get all App Service plans in an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListAppServicePlans.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites : get: operationId: AppServiceEnvironments_ListWebApps tags: - AppServiceEnvironments summary: Get all apps in an App Service Environment. description: Description for Get all apps in an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: propertiesToInclude in: query description: Comma separated list of app properties to include. required: false type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/WebAppCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get all apps in an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListWebApps.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend : post: operationId: AppServiceEnvironments_Suspend tags: - AppServiceEnvironments summary: Suspend an App Service Environment. description: Description for Suspend an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/WebAppCollection' '202': description: The request has been accepted for processing, but processing has not yet completed. schema: $ref: '#/definitions/WebAppCollection' headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Suspend an App Service Environment.: $ref: ./examples/AppServiceEnvironments_Suspend.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/WebAppCollection' x-ms-long-running-operation: true x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/testUpgradeAvailableNotification : post: operationId: AppServiceEnvironments_TestUpgradeAvailableNotification tags: - AppServiceEnvironments summary: Send a test notification that an upgrade is available for this App Service Environment. description: Send a test notification that an upgrade is available for this App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Send a test notification that an upgrade is available for this App Service Environment: $ref: ./examples/AppServiceEnvironments_TestUpgradeAvailableNotification.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade : post: operationId: AppServiceEnvironments_Upgrade tags: - AppServiceEnvironments summary: Initiate an upgrade of an App Service Environment if one is available. description: Description for Initiate an upgrade of an App Service Environment if one is available. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '202': description: Resource operation accepted. headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Initiate an upgrade on an App Service Environment: $ref: ./examples/AppServiceEnvironments_Upgrade.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages : get: operationId: AppServiceEnvironments_ListUsages tags: - AppServiceEnvironments summary: Get global usage metrics of an App Service Environment. description: Description for Get global usage metrics of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: $filter in: query description: 'Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq ''Metric1'' or name.value eq ''Metric2'') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration''[Hour|Minute|Day]''.' required: false type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/CsmUsageQuotaCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get global usage metrics of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListUsages.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools : get: operationId: AppServiceEnvironments_ListWorkerPools tags: - AppServiceEnvironments summary: Get all worker pools of an App Service Environment. description: Description for Get all worker pools of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/WorkerPoolCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get all worker pools of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListWorkerPools.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName} : get: operationId: AppServiceEnvironments_GetWorkerPool tags: - AppServiceEnvironments summary: Get properties of a worker pool. description: Description for Get properties of a worker pool. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: workerPoolName in: path description: Name of the worker pool. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/WorkerPoolResource' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get properties of a worker pool.: $ref: ./examples/AppServiceEnvironments_GetWorkerPool.json put: operationId: AppServiceEnvironments_CreateOrUpdateWorkerPool tags: - AppServiceEnvironments summary: Create or update a worker pool. description: Description for Create or update a worker pool. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: workerPoolName in: path description: Name of the worker pool. required: true type: string - name: workerPoolEnvelope in: body description: Properties of the worker pool. required: true schema: $ref: '#/definitions/WorkerPoolResource' responses: '200': description: Resource 'WorkerPoolResource' update operation succeeded schema: $ref: '#/definitions/WorkerPoolResource' '202': description: The request has been accepted for processing, but processing has not yet completed. schema: $ref: '#/definitions/WorkerPoolResource' headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get properties of a worker pool.: $ref: ./examples/AppServiceEnvironments_CreateOrUpdateWorkerPool_CreateOrUpdateWorkerPool.json x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/WorkerPoolResource' x-ms-long-running-operation: true patch: operationId: AppServiceEnvironments_UpdateWorkerPool tags: - AppServiceEnvironments summary: Create or update a worker pool. description: Description for Create or update a worker pool. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: workerPoolName in: path description: Name of the worker pool. required: true type: string - name: workerPoolEnvelope in: body description: Properties of the worker pool. required: true schema: $ref: '#/definitions/WorkerPoolResource' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/WorkerPoolResource' '202': description: The request has been accepted for processing, but processing has not yet completed. schema: $ref: '#/definitions/WorkerPoolResource' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get properties of a worker pool.: $ref: ./examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions : get: operationId: AppServiceEnvironments_ListWebWorkerMetricDefinitions tags: - AppServiceEnvironments summary: Get metric definitions for a worker pool of an App Service Environment. description: Description for Get metric definitions for a worker pool of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: workerPoolName in: path description: Name of the worker pool. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/ResourceMetricDefinitionCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get metric definitions for a worker pool of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListWebWorkerMetricDefinitions.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus : get: operationId: AppServiceEnvironments_ListWorkerPoolSkus tags: - AppServiceEnvironments summary: Get available SKUs for scaling a worker pool. description: Description for Get available SKUs for scaling a worker pool. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: workerPoolName in: path description: Name of the worker pool. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/SkuInfoCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get available SKUs for scaling a worker pool.: $ref: ./examples/AppServiceEnvironments_ListWorkerPoolSkus.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages : get: operationId: AppServiceEnvironments_ListWebWorkerUsages tags: - AppServiceEnvironments summary: Get usage metrics for a worker pool of an App Service Environment. description: Description for Get usage metrics for a worker pool of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: workerPoolName in: path description: Name of the worker pool. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/UsageCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get usage metrics for a worker pool of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListWebWorkerUsages.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName} : get: operationId: AppServiceEnvironments_GetDiagnosticsItem tags: - AppServiceEnvironments summary: Get a diagnostics item for an App Service Environment. description: Description for Get a diagnostics item for an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the app. required: true type: string - name: diagnosticsName in: path required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/HostingEnvironmentDiagnostics' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get a diagnostics item for an App Service Environment.: $ref: ./examples/AppServiceEnvironments_GetDiagnosticsItem.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions : get: operationId: AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions tags: - AppServiceEnvironments summary: Get metric definitions for a specific instance of a multi-role pool of an App Service Environment. description: Description for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: instance in: path description: Name of the instance in the multi-role pool. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/ResourceMetricDefinitionCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions : get: operationId: AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions tags: - AppServiceEnvironments summary: Get metric definitions for a specific instance of a worker pool of an App Service Environment. description: Description for Get metric definitions for a specific instance of a worker pool of an App Service Environment. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the App Service Environment. required: true type: string - name: workerPoolName in: path description: Name of the worker pool. required: true type: string - name: instance in: path description: Name of the instance in the worker pool. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/ResourceMetricDefinitionCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Get metric definitions for a specific instance of a worker pool of an App Service Environment.: $ref: ./examples/AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions.json x-ms-pageable: nextLinkName: nextLink definitions: ErrorEntity: type: object description: Body of the error response returned from the API. properties: extendedCode: type: string description: Type of error. messageTemplate: type: string description: Message template. parameters: type: array description: Parameters for the template. items: type: string innerErrors: type: array description: Inner errors. items: $ref: '#/definitions/ErrorEntity' x-ms-identifiers: [] details: type: array description: Error Details. items: $ref: '#/definitions/ErrorEntity' x-ms-identifiers: [] target: type: string description: The error target. code: type: string description: Basic error code. message: type: string description: Any details of the error. ApiManagementConfig: type: object description: Azure API management (APIM) configuration linked to the app. properties: id: type: string description: APIM-Api Identifier. ArmIdWrapper: type: object description: A wrapper for an ARM resource id properties: id: type: string readOnly: true FunctionsScaleAndConcurrencyTriggers: type: object description: Scale and concurrency settings for the function app triggers. properties: http: $ref: '#/definitions/FunctionsScaleAndConcurrencyTriggersHttp' description: Scale and concurrency settings for the HTTP trigger. FunctionsDeploymentStorageAuthentication: type: object description: Authentication method to access the storage account for deployment. properties: type: $ref: '#/definitions/AuthenticationType' description: 'Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.' userAssignedIdentityResourceId: type: string description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. storageAccountConnectionStringName: type: string description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. RedundancyMode: type: string description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant x-ms-enum: name: RedundancyMode modelAsString: false RuntimeName: type: string description: 'Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom' enum: - dotnet-isolated - node - java - powershell - python - custom x-ms-enum: name: RuntimeName modelAsString: true values: - name: dotnet-isolated value: dotnet-isolated - name: node value: node - name: java value: java - name: powershell value: powershell - name: python value: python - name: custom value: custom RampUpRule: type: object description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. properties: actionHostName: type: string description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. reroutePercentage: type: number format: double description: Percentage of the traffic which will be redirected to ActionHostName. changeStep: type: number format: double description: 'In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.' changeIntervalInMinutes: type: integer format: int32 description: Specifies interval in minutes to reevaluate ReroutePercentage. minReroutePercentage: type: number format: double description: Specifies lower boundary above which ReroutePercentage will stay. maxReroutePercentage: type: number format: double description: Specifies upper boundary below which ReroutePercentage will stay. changeDecisionCallbackUrl: type: string description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. name: type: string description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ResourceConfig: type: object description: Function app resource requirements. properties: cpu: type: number format: double description: Required CPU in cores, e.g. 0.5 memory: type: string description: Required memory, e.g. "1Gi" AzureStorageInfoValue: type: object description: Azure Files or Blob Storage access information value for dictionary storage. properties: type: $ref: '#/definitions/AzureStorageType' description: Type of storage. accountName: type: string description: Name of the storage account. shareName: type: string description: Name of the file share (container name, for Blob storage). accessKey: type: string format: password description: Access key for the storage account. x-ms-secret: true mountPath: type: string description: Path to mount the storage within the site's runtime environment. state: $ref: '#/definitions/AzureStorageState' description: State of the storage account. readOnly: true protocol: $ref: '#/definitions/AzureStorageProtocol' description: Mounting protocol to use for the storage account. Operation: type: object description: An operation on a resource. properties: id: type: string description: Operation ID. name: type: string description: Operation name. status: $ref: '#/definitions/OperationStatus' description: The current status of the operation. errors: type: array description: Any errors associate with the operation. items: $ref: '#/definitions/ErrorEntity' x-ms-identifiers: [] createdTime: type: string format: date-time description: Time when operation has started. modifiedTime: type: string format: date-time description: Time when operation has been updated. expirationTime: type: string format: date-time description: Time when operation will expire. geoMasterOperationId: type: string format: uuid description: Applicable only for stamp operation ids. SkuCapacity: type: object description: Description of the App Service plan scale options. properties: minimum: type: integer format: int32 description: Minimum number of workers for this App Service plan SKU. maximum: type: integer format: int32 description: Maximum number of workers for this App Service plan SKU. elasticMaximum: type: integer format: int32 description: Maximum number of Elastic workers for this App Service plan SKU. default: type: integer format: int32 description: Default number of workers for this App Service plan SKU. scaleType: type: string description: Available scale configurations for an App Service plan. StorageMountType: type: string description: Type of the storage mount. enum: - AzureFiles - LocalStorage - FileShare x-ms-enum: name: StorageMountType modelAsString: true values: - name: AzureFiles value: AzureFiles - name: LocalStorage value: LocalStorage - name: FileShare value: FileShare FunctionsAlwaysReadyConfig: type: object description: Sets the number of 'Always Ready' instances for a function group or a specific function. properties: name: type: string description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. instanceCount: type: integer format: int32 description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ConnectionStringType: type: string description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL x-ms-enum: name: ConnectionStringType modelAsString: false SkuInfoCollection: type: object description: Paged collection of SkuInfo items properties: value: type: array description: The SkuInfo items on this page items: $ref: '#/definitions/SkuInfo' x-ms-identifiers: - /sku/name - resourceType nextLink: type: string format: uri description: The link to the next page of items required: - value EndpointDependency: type: object description: A domain name that a service is reached at, including details of the current connection status. properties: domainName: type: string description: The domain name of the dependency. endpointDetails: type: array description: The IP Addresses and Ports used when connecting to DomainName. items: $ref: '#/definitions/EndpointDetail' x-ms-identifiers: - ipAddress - port AzureStorageType: type: string description: Type of storage. enum: - AzureFiles - AzureBlob x-ms-enum: name: AzureStorageType modelAsString: false AutoHealActionType: type: string description: Predefined action to be taken. enum: - Recycle - LogEvent - CustomAction x-ms-enum: name: AutoHealActionType modelAsString: false WebAppCollection: type: object description: Collection of App Service apps. properties: value: type: array description: The Site items on this page items: $ref: '#/definitions/Site' nextLink: type: string format: uri description: The link to the next page of items required: - value PushSettings: type: object description: Push settings for the App. properties: properties: $ref: '#/definitions/PushSettingsProperties' description: PushSettings resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/definitions/ProxyOnlyResource' PushSettingsProperties: type: object description: PushSettings resource specific properties properties: isPushEnabled: type: boolean description: Gets or sets a flag indicating whether the Push endpoint is enabled. tagWhitelistJson: type: string description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. tagsRequiringAuth: type: string description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." dynamicTagsJson: type: string description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. required: - isPushEnabled InboundEnvironmentEndpointCollection: type: object description: Collection of Inbound Environment Endpoints properties: value: type: array description: The InboundEnvironmentEndpoint items on this page items: $ref: '#/definitions/InboundEnvironmentEndpoint' nextLink: type: string format: uri description: The link to the next page of items required: - value KeyVaultReferenceWithStatus: type: object description: Object to hold key vault reference and the resolution status properties: secretUri: type: string description: Key vault secret URI. referenceStatus: type: string description: Reference status of the key vault secret. StampCapacity: type: object description: Stamp capacity information. properties: name: type: string description: Name of the stamp. availableCapacity: type: integer format: int64 description: Available capacity (# of machines, bytes of storage etc...). totalCapacity: type: integer format: int64 description: Total capacity (# of machines, bytes of storage etc...). unit: type: string description: Name of the unit. computeMode: $ref: '#/definitions/ComputeModeOptions' description: Shared/dedicated workers. workerSize: $ref: '#/definitions/WorkerSizeOptions' description: Size of the machines. workerSizeId: type: integer format: int32 description: 'Size ID of machines: 0 - Small 1 - Medium 2 - Large' excludeFromCapacityAllocation: type: boolean description: 'If true, it includes basic apps. Basic apps are not used for capacity allocation.' isApplicableForAllComputeModes: type: boolean description: true if capacity is applicable for all apps; otherwise, false. siteMode: type: string description: Shared or Dedicated. isLinux: type: boolean description: Is this a linux stamp capacity PrivateLinkResourceProperties: type: object description: Properties of a private link resource properties: groupId: type: string description: GroupId of a private link resource readOnly: true requiredMembers: type: array description: RequiredMembers of a private link resource items: type: string readOnly: true requiredZoneNames: type: array description: RequiredZoneNames of a private link resource items: type: string readOnly: true PrivateLinkResource: type: object description: A private link resource properties: id: type: string name: type: string description: Name of a private link resource type: type: string properties: $ref: '#/definitions/PrivateLinkResourceProperties' description: Properties of a private link resource required: - id - name - type - properties WorkerPoolResource: type: object description: Worker pool of an App Service Environment ARM resource. properties: properties: $ref: '#/definitions/WorkerPool' description: Core resource properties x-ms-client-flatten: true sku: $ref: '#/definitions/SkuDescription' description: Description of a SKU for a scalable resource. kind: type: string description: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource CustomDnsSuffixConfiguration: type: object description: Full view of the custom domain suffix configuration for ASEv3. properties: properties: $ref: '#/definitions/CustomDnsSuffixConfigurationProperties' description: CustomDnsSuffixConfiguration resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource AddressResponseProperties: type: object description: AddressResponse resource specific properties properties: serviceIpAddress: type: string description: Main public virtual IP. internalIpAddress: type: string description: Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode. outboundIpAddresses: type: array description: IP addresses appearing on outbound connections. items: type: string vipMappings: type: array description: Additional virtual IPs. items: $ref: '#/definitions/VirtualIPMapping' x-ms-identifiers: - virtualIP FunctionsRuntime: type: object description: Function app runtime name and version. properties: name: $ref: '#/definitions/RuntimeName' description: 'Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom' version: type: string description: 'Function app runtime version. Example: 8 (for dotnet-isolated)' x-nullable: true CustomDnsSuffixConfigurationProperties: type: object description: CustomDnsSuffixConfiguration resource specific properties properties: provisioningState: $ref: '#/definitions/CustomDnsSuffixProvisioningState' readOnly: true provisioningDetails: type: string readOnly: true dnsSuffix: type: string description: The default custom domain suffix to use for all sites deployed on the ASE. certificateUrl: type: string description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. keyVaultReferenceIdentity: type: string description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ResourceMetricAvailability: type: object description: Metrics availability and retention. properties: timeGrain: type: string description: Time grain . readOnly: true retention: type: string description: Retention period for the current time grain. readOnly: true ManagedServiceIdentityType: type: string description: Type of managed service identity. enum: - SystemAssigned - UserAssigned - SystemAssigned, UserAssigned - None x-ms-enum: name: ManagedServiceIdentityType modelAsString: false RemotePrivateEndpointConnectionARMResource: type: object description: Remote Private Endpoint Connection ARM resource. properties: properties: $ref: '#/definitions/RemotePrivateEndpointConnectionARMResourceProperties' description: RemotePrivateEndpointConnectionARMResource resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource FtpsState: type: string description: State of FTP / FTPS service enum: - AllAllowed - FtpsOnly - Disabled x-ms-enum: name: FtpsState modelAsString: true values: - name: AllAllowed value: AllAllowed - name: FtpsOnly value: FtpsOnly - name: Disabled value: Disabled AseV3NetworkingConfiguration: type: object description: Full view of networking configuration for an ASE. properties: properties: $ref: '#/definitions/AseV3NetworkingConfigurationProperties' description: AseV3NetworkingConfiguration resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource OutboundVnetRouting: type: object description: Outbound traffic options over virtual network. properties: allTraffic: type: boolean description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. applicationTraffic: type: boolean description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. contentShareTraffic: type: boolean description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled imagePullTraffic: type: boolean description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. backupRestoreTraffic: type: boolean description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled SlotSwapStatus: type: object description: The status of the last successful slot swap operation. properties: timestampUtc: type: string format: date-time description: The time the last successful slot swap completed. readOnly: true sourceSlotName: type: string description: The source slot of the last swap operation. readOnly: true destinationSlotName: type: string description: The destination slot of the last swap operation. readOnly: true AutoHealCustomAction: type: object description: 'Custom action to be executed when an auto heal rule is triggered.' properties: exe: type: string description: Executable to be run. parameters: type: string description: Parameters for the executable. PrivateLinkConnectionState: type: object description: The state of a private link connection properties: status: type: string description: Status of a private link connection description: type: string description: Description of a private link connection actionsRequired: type: string description: ActionsRequired for a private link connection UpgradeAvailability: type: string description: Whether an upgrade is available for this App Service Environment. enum: - None - Ready x-ms-enum: name: UpgradeAvailability modelAsString: true values: - name: None value: None description: No upgrade is currently available for this App Service Environment - name: Ready value: Ready description: An upgrade is ready to be manually initiated on this App Service Environment KubeEnvironmentProfile: type: object description: Specification for a Kubernetes Environment to use for this resource. properties: id: type: string description: Resource ID of the Kubernetes Environment. name: type: string description: Name of the Kubernetes Environment. readOnly: true type: type: string description: Resource type of the Kubernetes Environment. readOnly: true AutoHealTriggers: type: object description: Triggers for auto-heal. properties: requests: $ref: '#/definitions/RequestsBasedTrigger' description: A rule based on total requests. privateBytesInKB: type: integer format: int32 description: A rule based on private bytes. statusCodes: type: array description: A rule based on status codes. items: $ref: '#/definitions/StatusCodesBasedTrigger' x-ms-identifiers: - path slowRequests: $ref: '#/definitions/SlowRequestsBasedTrigger' description: A rule based on request execution time. slowRequestsWithPath: type: array description: A rule based on multiple Slow Requests Rule with path items: $ref: '#/definitions/SlowRequestsBasedTrigger' x-ms-identifiers: - path statusCodesRange: type: array description: A rule based on status codes ranges. items: $ref: '#/definitions/StatusCodesRangeBasedTrigger' x-ms-identifiers: - path PrivateEndpointConnectionCollection: type: object description: Paged collection of RemotePrivateEndpointConnectionARMResource items properties: value: type: array description: The RemotePrivateEndpointConnectionARMResource items on this page items: $ref: '#/definitions/RemotePrivateEndpointConnectionARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value RemotePrivateEndpointConnectionARMResourceProperties: type: object description: RemotePrivateEndpointConnectionARMResource resource specific properties properties: provisioningState: type: string readOnly: true privateEndpoint: $ref: '#/definitions/ArmIdWrapper' description: PrivateEndpoint of a remote private endpoint connection privateLinkServiceConnectionState: $ref: '#/definitions/PrivateLinkConnectionState' description: The state of a private link connection ipAddresses: type: array description: Private IPAddresses mapped to the remote private endpoint items: type: string ResourceMetricDefinitionCollection: type: object description: Collection of metric definitions. properties: value: type: array description: The ResourceMetricDefinition items on this page items: $ref: '#/definitions/ResourceMetricDefinition' nextLink: type: string format: uri description: The link to the next page of items required: - value UsageProperties: type: object description: Usage resource specific properties properties: displayName: type: string description: Friendly name shown in the UI. readOnly: true resourceName: type: string description: Name of the quota resource. readOnly: true unit: type: string description: Units of measurement for the quota resource. readOnly: true currentValue: type: integer format: int64 description: The current value of the resource counter. readOnly: true limit: type: integer format: int64 description: The resource limit. readOnly: true nextResetTime: type: string format: date-time description: Next reset time for the resource counter. readOnly: true computeMode: $ref: '#/definitions/ComputeModeOptions' description: Compute mode used for this usage. readOnly: true siteMode: type: string description: Site mode used for this usage. readOnly: true SslState: type: string description: SSL type enum: - Disabled - SniEnabled - IpBasedEnabled x-ms-enum: name: SslState modelAsString: false ResourceMetricDefinitionProperties: type: object description: ResourceMetricDefinition resource specific properties properties: unit: type: string description: Unit of the metric. readOnly: true primaryAggregationType: type: string description: Primary aggregation type. readOnly: true metricAvailabilities: type: array description: List of time grains supported for the metric together with retention period. items: $ref: '#/definitions/ResourceMetricAvailability' readOnly: true x-ms-identifiers: [] resourceUri: type: string description: Resource URI. readOnly: true properties: type: object description: Resource metric definition properties. additionalProperties: type: string readOnly: true HandlerMapping: type: object description: 'The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.' properties: extension: type: string description: Requests with this extension will be handled using the specified FastCGI application. scriptProcessor: type: string description: The absolute path to the FastCGI application. arguments: type: string description: Command-line arguments to be passed to the script processor. OperationStatus: type: string description: The current status of the operation. enum: - InProgress - Failed - Succeeded - TimedOut - Created x-ms-enum: name: OperationStatus modelAsString: false SlowRequestsBasedTrigger: type: object description: Trigger based on request execution time. properties: timeTaken: type: string description: Time taken. path: type: string description: Request Path. count: type: integer format: int32 description: Request Count. timeInterval: type: string description: Time interval. HostingEnvironmentDiagnostics: type: object description: Diagnostics for an App Service Environment. properties: name: type: string description: Name/identifier of the diagnostics. diagnosticsOutput: type: string description: Diagnostics output. CustomDnsSuffixProvisioningState: type: string enum: - Succeeded - Failed - Degraded - InProgress x-ms-enum: name: CustomDnsSuffixProvisioningState modelAsString: false AzureStorageState: type: string description: State of the storage account. enum: - Ok - InvalidCredentials - InvalidShare - NotValidated x-ms-enum: name: AzureStorageState modelAsString: false AseV3NetworkingConfigurationProperties: type: object description: AseV3NetworkingConfiguration resource specific properties properties: windowsOutboundIpAddresses: type: array items: type: string readOnly: true linuxOutboundIpAddresses: type: array items: type: string readOnly: true externalInboundIpAddresses: type: array items: type: string readOnly: true internalInboundIpAddresses: type: array items: type: string readOnly: true allowNewPrivateEndpointConnections: type: boolean description: Property to enable and disable new private endpoint connection creation on ASE ftpEnabled: type: boolean description: Property to enable and disable FTP on ASEV3 remoteDebugEnabled: type: boolean description: Property to enable and disable Remote Debug on ASEV3 inboundIpAddressOverride: type: string description: Customer provided Inbound IP Address. Only able to be set on Ase create. AutoHealActions: type: object description: Actions which to take by the auto-heal module when a rule is triggered. properties: actionType: $ref: '#/definitions/AutoHealActionType' description: Predefined action to be taken. customAction: $ref: '#/definitions/AutoHealCustomAction' description: Custom action to be taken. minProcessExecutionTime: type: string description: 'Minimum time the process must execute before taking the action' AppServiceEnvironmentPatchResource: type: object description: ARM resource for a app service environment. properties: properties: $ref: '#/definitions/AppServiceEnvironment' description: Core resource properties x-ms-client-flatten: true allOf: - $ref: '#/definitions/ProxyOnlyResource' AutoHealRules: type: object description: Rules that can be defined for auto-heal. properties: triggers: $ref: '#/definitions/AutoHealTriggers' description: Conditions that describe when to execute the auto-heal actions. actions: $ref: '#/definitions/AutoHealActions' description: Actions to be executed when a rule is triggered. IpSecurityRestriction: type: object description: IP security restriction on an app. properties: ipAddress: type: string description: 'IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.' subnetMask: type: string description: Subnet mask for the range of IP addresses the restriction is valid for. vnetSubnetResourceId: type: string description: Virtual network resource id vnetTrafficTag: type: integer format: int32 description: (internal) Vnet traffic tag subnetTrafficTag: type: integer format: int32 description: (internal) Subnet traffic tag action: type: string description: Allow or Deny access for this IP range. tag: $ref: '#/definitions/IpFilterTag' description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. priority: type: integer format: int32 description: Priority of IP restriction rule. name: type: string description: IP restriction rule name. description: type: string description: IP restriction rule description. headers: type: object description: 'IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don''t match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match.' additionalProperties: items: type: string type: array HostNameSslState: type: object description: SSL-enabled hostname. properties: name: type: string description: Hostname. sslState: $ref: '#/definitions/SslState' description: SSL type. virtualIP: type: string description: Virtual IP address assigned to the hostname if IP based SSL is enabled. thumbprint: type: string description: SSL certificate thumbprint. toUpdate: type: boolean description: Set to true to update existing hostname. hostType: $ref: '#/definitions/HostType' description: Indicates whether the hostname is a standard or repository hostname. StampCapacityCollection: type: object description: Paged collection of StampCapacity items properties: value: type: array description: The StampCapacity items on this page items: $ref: '#/definitions/StampCapacity' x-ms-identifiers: - name nextLink: type: string format: uri description: The link to the next page of items required: - value DefaultErrorResponseError: type: object description: Error model. properties: code: type: string description: Standardized string to programmatically identify the error. readOnly: true message: type: string description: Detailed error description and debugging information. readOnly: true target: type: string description: Detailed error description and debugging information. readOnly: true details: type: array items: $ref: '#/definitions/DefaultErrorResponseErrorDetailsItem' x-ms-identifiers: [] innererror: type: string description: More information to debug error. readOnly: true EndpointDetail: type: object description: Current TCP connectivity information from the App Service Environment to a single endpoint. properties: ipAddress: type: string description: An IP Address that Domain Name currently resolves to. port: type: integer format: int32 description: The port an endpoint is connected to. latency: type: number format: double description: The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress at this Port. isAccessible: type: boolean description: Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port. RegistryAdapter: type: object description: Server farm registry adapter configuration. properties: registryKey: type: string description: Registry key for the adapter. type: $ref: '#/definitions/RegistryAdapterType' description: Type of the registry adapter. keyVaultSecretReference: $ref: '#/definitions/KeyVaultReferenceWithStatus' description: Key vault reference to the value that will be placed in the registry location RegistryAdapterType: type: string description: Type of the registry adapter. enum: - Binary - String - Expand_String - Multi_String - DWord - QWord x-ms-enum: name: RegistryAdapterType modelAsString: true values: - name: Binary value: Binary - name: String value: String - name: Expand_String value: Expand_String - name: Multi_String value: Multi_String - name: DWord value: DWord - name: QWord value: QWord OutboundEnvironmentEndpoint: type: object description: Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to. properties: category: type: string description: The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory. endpoints: type: array description: The endpoints that the App Service Environment reaches the service at. items: $ref: '#/definitions/EndpointDependency' x-ms-identifiers: - domainName AuthenticationType: type: string description: 'Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.' enum: - SystemAssignedIdentity - UserAssignedIdentity - StorageAccountConnectionString x-ms-enum: name: AuthenticationType modelAsString: true values: - name: SystemAssignedIdentity value: SystemAssignedIdentity - name: UserAssignedIdentity value: UserAssignedIdentity - name: StorageAccountConnectionString value: StorageAccountConnectionString LocalizableString: type: object description: Localizable string object containing the name and a localized value. properties: value: type: string description: Non-localized name. localizedValue: type: string description: Localized name. CloningInfo: type: object description: Information needed for cloning operation. properties: correlationId: type: string format: uuid description: 'Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.' overwrite: type: boolean description: true to overwrite destination app; otherwise, false. cloneCustomHostNames: type: boolean description: true to clone custom hostnames from source app; otherwise, false. cloneSourceControl: type: boolean description: true to clone source control from source app; otherwise, false. sourceWebAppId: type: string description: 'ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.' sourceWebAppLocation: type: string description: 'Location of source app ex: West US or North Europe' hostingEnvironment: type: string description: App Service Environment. appSettingsOverrides: type: object description: 'Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.' additionalProperties: type: string configureLoadBalancing: type: boolean description: true to configure load balancing for source and destination app. trafficManagerProfileId: type: string description: 'ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.' trafficManagerProfileName: type: string description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. required: - sourceWebAppId SiteUpdateStrategyType: type: string description: 'Function app site update strategy type. Available options: Recreate, RollingUpdate' enum: - Recreate - RollingUpdate x-ms-enum: name: SiteUpdateStrategyType modelAsString: true values: - name: Recreate value: Recreate description: 'If the app is under load and a deployment or site state update occurs, all pods will be removed and will need to be Recreated all at once. This is the default behavior.' - name: RollingUpdate value: RollingUpdate description: 'If the app is under load and a deployment or site state update occurs, pods will be drained in batches and gradually replaced, thus minimizing impact to throughput.' SiteLoadBalancing: type: string description: Site load balancing. enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash - PerSiteRoundRobin - LeastRequestsWithTieBreaker x-ms-enum: name: SiteLoadBalancing modelAsString: false WorkerPoolCollection: type: object description: Collection of worker pools. properties: value: type: array description: The WorkerPoolResource items on this page items: $ref: '#/definitions/WorkerPoolResource' nextLink: type: string format: uri description: The link to the next page of items required: - value VirtualDirectory: type: object description: Directory for virtual application. properties: virtualPath: type: string description: Path to virtual application. physicalPath: type: string description: Physical path. InstallScriptType: type: string description: Type of the install script. enum: - RemoteAzureBlob - PlatformStorage x-ms-enum: name: InstallScriptType modelAsString: true values: - name: RemoteAzureBlob value: RemoteAzureBlob - name: PlatformStorage value: PlatformStorage DefaultAction: type: string description: Default action for main access restriction if no rules are matched. enum: - Allow - Deny x-ms-enum: name: DefaultAction modelAsString: true values: - name: Allow value: Allow - name: Deny value: Deny FunctionsDeployment: type: object description: Configuration section for the function app deployment. properties: storage: $ref: '#/definitions/FunctionsDeploymentStorage' description: Storage for deployed package used by the function app. HostingEnvironmentStatus: type: string description: Current status of the App Service Environment. enum: - Preparing - Ready - Scaling - Deleting x-ms-enum: name: HostingEnvironmentStatus modelAsString: false ManagedPipelineMode: type: string description: Managed pipeline mode. enum: - Integrated - Classic x-ms-enum: name: ManagedPipelineMode modelAsString: false AppServicePlanCollection: type: object description: Collection of App Service plans. properties: value: type: array description: The AppServicePlan items on this page items: $ref: '#/definitions/AppServicePlan' nextLink: type: string format: uri description: The link to the next page of items required: - value AppServiceEnvironmentResource: type: object description: App Service Environment ARM resource. properties: properties: $ref: '#/definitions/AppServiceEnvironment' description: Core resource properties x-ms-client-flatten: true kind: type: string description: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource OutboundEnvironmentEndpointCollection: type: object description: Paged collection of OutboundEnvironmentEndpoint items properties: value: type: array description: The OutboundEnvironmentEndpoint items on this page items: $ref: '#/definitions/OutboundEnvironmentEndpoint' x-ms-identifiers: - category nextLink: type: string format: uri description: The link to the next page of items required: - value InstallScriptSource: type: object description: Object to hold install script reference. properties: sourceUri: type: string description: Install script source URI where the install script file will be fetched from. type: $ref: '#/definitions/InstallScriptType' description: Type of the install script. IPMode: type: string description: Specifies the IP mode of the app. enum: - IPv4 - IPv6 - IPv4AndIPv6 x-ms-enum: name: IPMode modelAsString: false SkuInfo: type: object description: SKU discovery information. properties: resourceType: type: string description: Resource type that this SKU applies to. sku: $ref: '#/definitions/SkuDescription' description: Name and tier of the SKU. capacity: $ref: '#/definitions/SkuCapacity' description: Min, max, and default scale values of the SKU. ProvisioningState: type: string description: Provisioning state of the App Service Plan. enum: - Succeeded - Failed - Canceled - InProgress - Deleting x-ms-enum: name: ProvisioningState modelAsString: false DefaultErrorResponse: type: object description: App Service error response. properties: error: $ref: '#/definitions/DefaultErrorResponseError' description: Error model. readOnly: true ServerFarmNetworkSettings: type: object description: Network settings for an app service plan. properties: virtualNetworkSubnetId: type: string description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} SiteAvailabilityState: type: string description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode x-ms-enum: name: SiteAvailabilityState modelAsString: false DefaultErrorResponseErrorDetailsItem: type: object description: Detailed errors. properties: code: type: string description: Standardized string to programmatically identify the error. readOnly: true message: type: string description: Detailed error description and debugging information. readOnly: true target: type: string description: Detailed error description and debugging information. readOnly: true SupportedTlsVersions: type: string description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' enum: - '1.0' - '1.1' - '1.2' - '1.3' x-ms-enum: name: SupportedTlsVersions modelAsString: true values: - name: '1.0' value: '1.0' - name: '1.1' value: '1.1' - name: '1.2' value: '1.2' - name: '1.3' value: '1.3' NameValuePair: type: object description: Name value pair. properties: name: type: string description: Pair name. value: type: string description: Pair value. StatusCodesBasedTrigger: type: object description: Trigger based on status code. properties: status: type: integer format: int32 description: HTTP status code. subStatus: type: integer format: int32 description: Request Sub Status. win32Status: type: integer format: int32 description: Win32 error code. count: type: integer format: int32 description: Request Count. timeInterval: type: string description: Time interval. path: type: string description: Request Path TlsCipherSuites: type: string description: The minimum strength TLS cipher suite allowed for an application enum: - TLS_AES_256_GCM_SHA384 - TLS_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA x-ms-enum: name: TlsCipherSuites modelAsString: true values: - name: TLS_AES_256_GCM_SHA384 value: TLS_AES_256_GCM_SHA384 - name: TLS_AES_128_GCM_SHA256 value: TLS_AES_128_GCM_SHA256 - name: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 value: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - name: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 value: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - name: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 value: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - name: TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 value: TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - name: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 value: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - name: TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 value: TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - name: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 value: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - name: TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA value: TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - name: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA value: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - name: TLS_RSA_WITH_AES_256_GCM_SHA384 value: TLS_RSA_WITH_AES_256_GCM_SHA384 - name: TLS_RSA_WITH_AES_128_GCM_SHA256 value: TLS_RSA_WITH_AES_128_GCM_SHA256 - name: TLS_RSA_WITH_AES_256_CBC_SHA256 value: TLS_RSA_WITH_AES_256_CBC_SHA256 - name: TLS_RSA_WITH_AES_128_CBC_SHA256 value: TLS_RSA_WITH_AES_128_CBC_SHA256 - name: TLS_RSA_WITH_AES_256_CBC_SHA value: TLS_RSA_WITH_AES_256_CBC_SHA - name: TLS_RSA_WITH_AES_128_CBC_SHA value: TLS_RSA_WITH_AES_128_CBC_SHA ApiDefinitionInfo: type: object description: Information about the formal API definition for the app. properties: url: type: string description: The URL of the API definition. AddressResponse: type: object description: Describes main public IP address and any extra virtual IPs. properties: properties: $ref: '#/definitions/AddressResponseProperties' description: AddressResponse resource specific properties x-ms-client-flatten: true kind: type: string description: Kind of resource. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource RequestsBasedTrigger: type: object description: Trigger based on total requests. properties: count: type: integer format: int32 description: Request Count. timeInterval: type: string description: Time interval. DaprConfig: type: object description: App Dapr configuration. properties: enabled: type: boolean description: Boolean indicating if the Dapr side car is enabled default: false appId: type: string description: Dapr application identifier appPort: type: integer format: int32 description: Tells Dapr which port your application is listening on httpReadBufferSize: type: integer format: int32 description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. httpMaxRequestSize: type: integer format: int32 description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. logLevel: $ref: '#/definitions/DaprLogLevel' description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. enableApiLogging: type: boolean description: Enables API logging for the Dapr sidecar LoadBalancingMode: type: string description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. enum: - None - Web - Publishing - Web, Publishing x-ms-enum: name: LoadBalancingMode modelAsString: true values: - name: None value: None - name: Web value: Web - name: Publishing value: Publishing - name: Web, Publishing value: Web, Publishing ResourceMetricDefinition: type: object description: Metadata for the metrics. properties: properties: $ref: '#/definitions/ResourceMetricDefinitionProperties' description: ResourceMetricDefinition resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/definitions/ProxyOnlyResource' AppServiceEnvironment: type: object description: Description of an App Service Environment. properties: provisioningState: $ref: '#/definitions/ProvisioningState' description: Provisioning state of the App Service Environment. readOnly: true status: $ref: '#/definitions/HostingEnvironmentStatus' description: Current status of the App Service Environment. readOnly: true virtualNetwork: $ref: '#/definitions/VirtualNetworkProfile' description: Description of the Virtual Network. internalLoadBalancingMode: $ref: '#/definitions/LoadBalancingMode' description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. multiSize: type: string description: Front-end VM size, e.g. "Medium", "Large". multiRoleCount: type: integer format: int32 description: Number of front-end instances. readOnly: true ipsslAddressCount: type: integer format: int32 description: Number of IP SSL addresses reserved for the App Service Environment. dnsSuffix: type: string description: DNS suffix of the App Service Environment. maximumNumberOfMachines: type: integer format: int32 description: Maximum number of VMs in the App Service Environment. readOnly: true frontEndScaleFactor: type: integer format: int32 description: Scale factor for front-ends. suspended: type: boolean description: 'true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).' readOnly: true clusterSettings: type: array description: Custom settings for changing the behavior of the App Service Environment. items: $ref: '#/definitions/NameValuePair' x-ms-identifiers: - name userWhitelistedIpRanges: type: array description: User added ip ranges to whitelist on ASE db items: type: string hasLinuxWorkers: type: boolean description: Flag that displays whether an ASE has linux workers or not readOnly: true upgradePreference: type: string description: Upgrade Preference default: None enum: - None - Early - Late - Manual x-ms-enum: name: UpgradePreference modelAsString: true values: - name: None value: None description: No preference on when this App Service Environment will be upgraded - name: Early value: Early description: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' - name: Late value: Late description: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' - name: Manual value: Manual description: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically dedicatedHostCount: type: integer format: int32 description: Dedicated Host Count zoneRedundant: type: boolean description: Whether or not this App Service Environment is zone-redundant. customDnsSuffixConfiguration: $ref: '#/definitions/CustomDnsSuffixConfiguration' description: Full view of the custom domain suffix configuration for ASEv3. networkingConfiguration: $ref: '#/definitions/AseV3NetworkingConfiguration' description: Full view of networking configuration for an ASE. upgradeAvailability: $ref: '#/definitions/UpgradeAvailability' description: Whether an upgrade is available for this App Service Environment. readOnly: true required: - virtualNetwork CorsSettings: type: object description: Cross-Origin Resource Sharing (CORS) settings for the app. properties: allowedOrigins: type: array description: 'Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all.' items: type: string supportCredentials: type: boolean description: 'Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details.' ConnStringInfo: type: object description: Database connection string information. properties: name: type: string description: Name of connection string. connectionString: type: string description: Connection string value. type: $ref: '#/definitions/ConnectionStringType' description: Type of database. Site: type: object description: A web app, a mobile app backend, or an API app. properties: properties: $ref: '#/definitions/SiteProperties' description: Site resource specific properties x-ms-client-flatten: true identity: $ref: '#/definitions/ManagedServiceIdentity' description: Managed service identity. extendedLocation: $ref: '#/definitions/ExtendedLocation' description: Extended Location. kind: type: string description: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource ScmType: type: string description: SCM type. enum: - None - Dropbox - Tfs - LocalGit - GitHub - CodePlexGit - CodePlexHg - BitbucketGit - BitbucketHg - ExternalGit - ExternalHg - OneDrive - VSO - VSTSRM x-ms-enum: name: ScmType modelAsString: true values: - name: None value: None - name: Dropbox value: Dropbox - name: Tfs value: Tfs - name: LocalGit value: LocalGit - name: GitHub value: GitHub - name: CodePlexGit value: CodePlexGit - name: CodePlexHg value: CodePlexHg - name: BitbucketGit value: BitbucketGit - name: BitbucketHg value: BitbucketHg - name: ExternalGit value: ExternalGit - name: ExternalHg value: ExternalHg - name: OneDrive value: OneDrive - name: VSO value: VSO - name: VSTSRM value: VSTSRM ClientCertMode: type: string description: 'This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.' enum: - Required - Optional - OptionalInteractiveUser x-ms-enum: name: ClientCertMode modelAsString: false DaprLogLevel: type: string description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. enum: - info - debug - warn - error x-ms-enum: name: DaprLogLevel modelAsString: true values: - name: info value: info - name: debug value: debug - name: warn value: warn - name: error value: error StatusOptions: type: string description: App Service plan status. enum: - Ready - Pending - Creating x-ms-enum: name: StatusOptions modelAsString: false ManagedServiceIdentity: type: object description: Managed service identity. properties: type: $ref: '#/definitions/ManagedServiceIdentityType' description: Type of managed service identity. tenantId: type: string description: Tenant of managed service identity. readOnly: true principalId: type: string description: Principal Id of managed service identity. readOnly: true userAssignedIdentities: type: object description: 'The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' additionalProperties: $ref: '#/definitions/UserAssignedIdentity' AppServicePlanProperties: type: object description: AppServicePlan resource specific properties properties: workerTierName: type: string description: Target worker tier assigned to the App Service plan. status: $ref: '#/definitions/StatusOptions' description: App Service plan status. readOnly: true subscription: type: string description: App Service plan subscription. readOnly: true hostingEnvironmentProfile: $ref: '#/definitions/HostingEnvironmentProfile' description: Specification for the App Service Environment to use for the App Service plan. x-ms-mutability: - read - create maximumNumberOfWorkers: type: integer format: int32 description: Maximum number of instances that can be assigned to this App Service plan. readOnly: true numberOfWorkers: type: integer format: int32 description: The number of instances that are assigned to this App Service plan. readOnly: true geoRegion: type: string description: Geographical location for the App Service plan. readOnly: true perSiteScaling: type: boolean description: 'If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.' elasticScaleEnabled: type: boolean description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku maximumElasticWorkerCount: type: integer format: int32 description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan numberOfSites: type: integer format: int32 description: Number of apps assigned to this App Service plan. readOnly: true isSpot: type: boolean description: If true, this App Service Plan owns spot instances. spotExpirationTime: type: string format: date-time description: The time when the server farm expires. Valid only if it is a spot server farm. freeOfferExpirationTime: type: string format: date-time description: The time when the server farm free offer expires. resourceGroup: type: string description: Resource group of the App Service plan. readOnly: true reserved: type: boolean description: If Linux app service plan true, false otherwise. x-ms-mutability: - read - create isXenon: type: boolean description: 'Obsolete: If Hyper-V container app service plan true, false otherwise.' x-ms-mutability: - read - create hyperV: type: boolean description: If Hyper-V container app service plan true, false otherwise. x-ms-mutability: - read - create targetWorkerCount: type: integer format: int32 description: Scaling worker count. targetWorkerSizeId: type: integer format: int32 description: Scaling worker size ID. provisioningState: $ref: '#/definitions/ProvisioningState' description: Provisioning state of the App Service Plan. readOnly: true kubeEnvironmentProfile: $ref: '#/definitions/KubeEnvironmentProfile' description: Specification for the Kubernetes Environment to use for the App Service plan. zoneRedundant: type: boolean description: 'If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.' asyncScalingEnabled: type: boolean description: 'If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling.' planDefaultIdentity: $ref: '#/definitions/DefaultIdentity' description: Identity to use by platform for various features and integrations using managed identity. isCustomMode: type: boolean description: Whether this server farm is in custom mode. registryAdapters: type: array description: Registry adapters associated with this App Service plan. items: $ref: '#/definitions/RegistryAdapter' x-ms-identifiers: [] installScripts: type: array description: Install scripts associated with this App Service plan. items: $ref: '#/definitions/InstallScript' network: $ref: '#/definitions/ServerFarmNetworkSettings' description: All network settings for the server farm. storageMounts: type: array description: Storage mounts associated with this App Service plan. items: $ref: '#/definitions/StorageMount' rdpEnabled: type: boolean description: 'If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled.' Capability: type: object description: Describes the capabilities/features allowed for a specific SKU. properties: name: type: string description: Name of the SKU capability. value: type: string description: Value of the SKU capability. reason: type: string description: Reason of the SKU capability. ProxyOnlyResource: type: object description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: type: string description: Resource Id. readOnly: true name: type: string description: Resource Name. readOnly: true kind: type: string description: Kind of resource. type: type: string description: Resource type. readOnly: true SiteProperties: type: object description: Site resource specific properties properties: state: type: string description: Current state of the app. readOnly: true hostNames: type: array description: Hostnames associated with the app. items: type: string readOnly: true repositorySiteName: type: string description: Name of the repository site. readOnly: true usageState: $ref: '#/definitions/UsageState' description: State indicating whether the app has exceeded its quota usage. Read-only. readOnly: true enabled: type: boolean description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). enabledHostNames: type: array description: 'Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.' items: type: string readOnly: true availabilityState: $ref: '#/definitions/SiteAvailabilityState' description: Management information availability state for the app. readOnly: true hostNameSslStates: type: array description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. items: $ref: '#/definitions/HostNameSslState' x-ms-identifiers: - name serverFarmId: type: string description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' reserved: type: boolean description: true if reserved; otherwise, false. default: false x-ms-mutability: - read - create isXenon: type: boolean description: 'Obsolete: Hyper-V sandbox.' default: false x-ms-mutability: - read - create hyperV: type: boolean description: Hyper-V sandbox. default: false x-ms-mutability: - read - create lastModifiedTimeUtc: type: string format: date-time description: Last time the app was modified, in UTC. Read-only. readOnly: true dnsConfiguration: $ref: '#/definitions/SiteDnsConfig' description: Property to configure various DNS related settings for a site. outboundVnetRouting: $ref: '#/definitions/OutboundVnetRouting' description: Property to configure various outbound traffic routing options over virtual network for a site siteConfig: $ref: '#/definitions/SiteConfig' description: Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. x-ms-mutability: - update - create functionAppConfig: $ref: '#/definitions/FunctionAppConfig' description: Configuration specific of the Azure Function app. daprConfig: $ref: '#/definitions/DaprConfig' description: Dapr configuration of the app. workloadProfileName: type: string description: Workload profile name for function app to execute on. resourceConfig: $ref: '#/definitions/ResourceConfig' description: Function app resource requirements. trafficManagerHostNames: type: array description: Azure Traffic Manager hostnames associated with the app. Read-only. items: type: string readOnly: true scmSiteAlsoStopped: type: boolean description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. default: false targetSwapSlot: type: string description: Specifies which deployment slot this app will swap into. Read-only. readOnly: true hostingEnvironmentProfile: $ref: '#/definitions/HostingEnvironmentProfile' description: App Service Environment to use for the app. x-ms-mutability: - read - create clientAffinityEnabled: type: boolean description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. default: false clientAffinityPartitioningEnabled: type: boolean description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. clientAffinityProxyEnabled: type: boolean description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. clientCertEnabled: type: boolean description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. clientCertMode: $ref: '#/definitions/ClientCertMode' description: 'This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.' clientCertExclusionPaths: type: string description: client certificate authentication comma-separated exclusion paths ipMode: $ref: '#/definitions/IPMode' description: Specifies the IP mode of the app. endToEndEncryptionEnabled: type: boolean description: Whether to use end to end encryption between the FrontEnd and the Worker sshEnabled: type: boolean description: Whether to enable ssh access. hostNamesDisabled: type: boolean description: 'true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.' customDomainVerificationId: type: string description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. outboundIpAddresses: type: string description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. readOnly: true possibleOutboundIpAddresses: type: string description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. readOnly: true containerSize: type: integer format: int32 description: Size of the function container. dailyMemoryTimeQuota: type: integer format: int32 description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). suspendedTill: type: string format: date-time description: App suspended till in case memory-time quota is exceeded. readOnly: true maxNumberOfWorkers: type: integer format: int32 description: 'Maximum number of workers. This only applies to Functions container.' readOnly: true cloningInfo: $ref: '#/definitions/CloningInfo' description: If specified during app creation, the app is cloned from a source app. x-ms-mutability: - create resourceGroup: type: string description: Name of the resource group the app belongs to. Read-only. readOnly: true isDefaultContainer: type: boolean description: true if the app is a default container; otherwise, false. readOnly: true defaultHostName: type: string description: Default hostname of the app. Read-only. readOnly: true slotSwapStatus: $ref: '#/definitions/SlotSwapStatus' description: Status of the last deployment slot swap operation. readOnly: true httpsOnly: type: boolean description: 'HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests' redundancyMode: $ref: '#/definitions/RedundancyMode' description: Site redundancy mode inProgressOperationId: type: string format: uuid description: Specifies an operation id if this site has a pending operation. readOnly: true publicNetworkAccess: type: string description: 'Property to allow or block all public traffic. Allowed Values: ''Enabled'', ''Disabled'' or an empty string.' storageAccountRequired: type: boolean description: Checks if Customer provided storage account is required keyVaultReferenceIdentity: type: string description: Identity to use for Key Vault Reference authentication. autoGeneratedDomainNameLabelScope: $ref: '#/definitions/AutoGeneratedDomainNameLabelScope' description: Specifies the scope of uniqueness for the default hostname during resource creation virtualNetworkSubnetId: type: string description: 'Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}' managedEnvironmentId: type: string description: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} sku: type: string description: Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 readOnly: true AzureStorageProtocol: type: string description: Mounting protocol to use for the storage account. enum: - Smb - Http - Nfs x-ms-enum: name: AzureStorageProtocol modelAsString: true values: - name: Smb value: Smb - name: Http value: Http - name: Nfs value: Nfs SiteLimits: type: object description: Metric limits set on an app. properties: maxPercentageCpu: type: number format: double description: Maximum allowed CPU usage percentage. maxMemoryInMb: type: integer format: int64 description: Maximum allowed memory usage in MB. maxDiskSizeInMb: type: integer format: int64 description: Maximum allowed disk size usage in MB. FunctionsScaleAndConcurrencyTriggersHttp: type: object description: Scale and concurrency settings for the HTTP trigger. properties: perInstanceConcurrency: type: integer format: int32 description: The maximum number of concurrent HTTP trigger invocations per instance. CsmUsageQuota: type: object description: Usage of the quota resource. properties: unit: type: string description: Units of measurement for the quota resource. nextResetTime: type: string format: date-time description: Next reset time for the resource counter. currentValue: type: integer format: int64 description: The current value of the resource counter. limit: type: integer format: int64 description: The resource limit. name: $ref: '#/definitions/LocalizableString' description: Quota name. UsageCollection: type: object description: Collection of usages. properties: value: type: array description: The Usage items on this page items: $ref: '#/definitions/Usage' nextLink: type: string format: uri description: The link to the next page of items required: - value ExtendedLocation: type: object description: Extended Location. properties: name: type: string description: Name of extended location. type: type: string description: Type of extended location. readOnly: true FunctionsSiteUpdateStrategy: type: object description: Function app site update strategy configuration for deployments and site config updates. properties: type: $ref: '#/definitions/SiteUpdateStrategyType' description: 'Function app site update strategy type. Available options: Recreate, RollingUpdate' InstallScript: type: object description: Server farm install script configuration. properties: name: type: string description: Name of the install script. source: $ref: '#/definitions/InstallScriptSource' description: Source of the install script. SiteMachineKey: type: object description: MachineKey of an app. properties: validation: type: string description: MachineKey validation. validationKey: type: string description: Validation key. decryption: type: string description: Algorithm used for decryption. decryptionKey: type: string description: Decryption key. FunctionsScaleAndConcurrency: type: object description: Scale and concurrency settings for the function app. properties: alwaysReady: type: array description: '''Always Ready'' configuration for the function app.' items: $ref: '#/definitions/FunctionsAlwaysReadyConfig' maximumInstanceCount: type: integer format: int32 description: The maximum number of instances for the function app. instanceMemoryMB: type: integer format: int32 description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. triggers: $ref: '#/definitions/FunctionsScaleAndConcurrencyTriggers' description: Scale and concurrency settings for the function app triggers. CsmUsageQuotaCollection: type: object description: Paged collection of CsmUsageQuota items properties: value: type: array description: The CsmUsageQuota items on this page items: $ref: '#/definitions/CsmUsageQuota' x-ms-identifiers: - name nextLink: type: string format: uri description: The link to the next page of items required: - value FunctionsDeploymentStorageType: type: string description: 'Property to select Azure Storage type. Available options: blobContainer.' enum: - blobContainer x-ms-enum: name: FunctionsDeploymentStorageType modelAsString: true values: - name: blobContainer value: blobContainer VirtualApplication: type: object description: Virtual application in an app. properties: virtualPath: type: string description: Virtual path. physicalPath: type: string description: Physical path. preloadEnabled: type: boolean description: true if preloading is enabled; otherwise, false. virtualDirectories: type: array description: Virtual directories for virtual application. items: $ref: '#/definitions/VirtualDirectory' x-ms-identifiers: - virtualPath AutoGeneratedDomainNameLabelScope: type: string description: Specifies the scope of uniqueness for the default hostname during resource creation enum: - TenantReuse - SubscriptionReuse - ResourceGroupReuse - NoReuse x-ms-enum: name: AutoGeneratedDomainNameLabelScope modelAsString: false StatusCodesRangeBasedTrigger: type: object description: Trigger based on range of status codes. properties: statusCodes: type: string description: HTTP status code. path: type: string count: type: integer format: int32 description: Request Count. timeInterval: type: string description: Time interval. StorageMount: type: object description: Server farm storage mount configuration. properties: name: type: string description: Name of the storage mount. type: $ref: '#/definitions/StorageMountType' description: Type of the storage mount. source: type: string description: Source of the fileshare/storage. destinationPath: type: string description: Path on worker where storage will be mounted. credentialsKeyVaultReference: $ref: '#/definitions/KeyVaultReferenceWithStatus' description: KV reference to the credentials to connect to the share. DefaultIdentity: type: object properties: identityType: $ref: '#/definitions/ManagedServiceIdentityType' userAssignedIdentityResourceId: type: string HostType: type: string description: Indicates whether the hostname is a standard or repository hostname. enum: - Standard - Repository x-ms-enum: name: HostType modelAsString: false FunctionAppConfig: type: object description: Function app configuration. properties: deployment: $ref: '#/definitions/FunctionsDeployment' description: Function app deployment configuration. runtime: $ref: '#/definitions/FunctionsRuntime' description: Function app runtime settings. scaleAndConcurrency: $ref: '#/definitions/FunctionsScaleAndConcurrency' description: Function app scale and concurrency settings. siteUpdateStrategy: $ref: '#/definitions/FunctionsSiteUpdateStrategy' description: Function app site update strategy configuration. ComputeModeOptions: type: string description: Shared/dedicated workers. enum: - Shared - Dedicated - Dynamic x-ms-enum: name: ComputeModeOptions modelAsString: false WorkerSizeOptions: type: string description: Size of the machines. enum: - Small - Medium - Large - D1 - D2 - D3 - SmallV3 - MediumV3 - LargeV3 - NestedSmall - NestedSmallLinux - Default x-ms-enum: name: WorkerSizeOptions modelAsString: false SkuDescription: type: object description: Description of a SKU for a scalable resource. properties: name: type: string description: Name of the resource SKU. tier: type: string description: Service tier of the resource SKU. size: type: string description: Size specifier of the resource SKU. family: type: string description: Family code of the resource SKU. capacity: type: integer format: int32 description: Current number of instances assigned to the resource. skuCapacity: $ref: '#/definitions/SkuCapacity' description: Min, max, and default scale values of the SKU. locations: type: array description: Locations of the SKU. items: type: string capabilities: type: array description: Capabilities of the SKU, e.g., is traffic manager enabled? items: $ref: '#/definitions/Capability' x-ms-identifiers: - name IpFilterTag: type: string description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy - ServiceTag x-ms-enum: name: IpFilterTag modelAsString: true values: - name: Default value: Default - name: XffProxy value: XffProxy - name: ServiceTag value: ServiceTag SiteConfig: type: object description: Configuration of an App Service app. properties: numberOfWorkers: type: integer format: int32 description: Number of workers. defaultDocuments: type: array description: Default documents. items: type: string netFrameworkVersion: type: string description: .NET Framework version. default: v4.6 phpVersion: type: string description: Version of PHP. pythonVersion: type: string description: Version of Python. nodeVersion: type: string description: Version of Node.js. powerShellVersion: type: string description: Version of PowerShell. linuxFxVersion: type: string description: Linux App Framework and version windowsFxVersion: type: string description: Xenon App Framework and version requestTracingEnabled: type: boolean description: true if request tracing is enabled; otherwise, false. requestTracingExpirationTime: type: string format: date-time description: Request tracing expiration time. remoteDebuggingEnabled: type: boolean description: true if remote debugging is enabled; otherwise, false. remoteDebuggingVersion: type: string description: Remote debugging version. httpLoggingEnabled: type: boolean description: true if HTTP logging is enabled; otherwise, false. acrUseManagedIdentityCreds: type: boolean description: Flag to use Managed Identity Creds for ACR pull acrUserManagedIdentityID: type: string description: If using user managed identity, the user managed identity ClientId logsDirectorySizeLimit: type: integer format: int32 description: HTTP logs directory size limit. detailedErrorLoggingEnabled: type: boolean description: true if detailed error logging is enabled; otherwise, false. publishingUsername: type: string description: Publishing user name. appSettings: type: array description: Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. items: $ref: '#/definitions/NameValuePair' x-ms-identifiers: - name x-ms-mutability: - update - create metadata: type: array description: Application metadata. This property cannot be retrieved, since it may contain secrets. items: $ref: '#/definitions/NameValuePair' x-ms-identifiers: - name x-ms-mutability: - update - create connectionStrings: type: array description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. items: $ref: '#/definitions/ConnStringInfo' x-ms-identifiers: - name x-ms-mutability: - update - create machineKey: $ref: '#/definitions/SiteMachineKey' description: Site MachineKey. readOnly: true handlerMappings: type: array description: Handler mappings. items: $ref: '#/definitions/HandlerMapping' x-ms-identifiers: - extension documentRoot: type: string description: Document root. scmType: $ref: '#/definitions/ScmType' description: SCM type. use32BitWorkerProcess: type: boolean description: true to use 32-bit worker process; otherwise, false. webSocketsEnabled: type: boolean description: true if WebSocket is enabled; otherwise, false. alwaysOn: type: boolean description: true if Always On is enabled; otherwise, false. javaVersion: type: string description: Java version. javaContainer: type: string description: Java container. javaContainerVersion: type: string description: Java container version. appCommandLine: type: string description: App command line to launch. managedPipelineMode: $ref: '#/definitions/ManagedPipelineMode' description: Managed pipeline mode. virtualApplications: type: array description: Virtual applications. items: $ref: '#/definitions/VirtualApplication' x-ms-identifiers: - virtualPath loadBalancing: $ref: '#/definitions/SiteLoadBalancing' description: Site load balancing. experiments: $ref: '#/definitions/Experiments' description: This is work around for polymorphic types. limits: $ref: '#/definitions/SiteLimits' description: Site limits. autoHealEnabled: type: boolean description: true if Auto Heal is enabled; otherwise, false. autoHealRules: $ref: '#/definitions/AutoHealRules' description: Auto Heal rules. tracingOptions: type: string description: Tracing options. vnetName: type: string description: Virtual Network name. x-ms-mutability: - read - create vnetRouteAllEnabled: type: boolean description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. vnetPrivatePortsCount: type: integer format: int32 description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. cors: $ref: '#/definitions/CorsSettings' description: Cross-Origin Resource Sharing (CORS) settings. push: $ref: '#/definitions/PushSettings' description: Push endpoint settings. apiDefinition: $ref: '#/definitions/ApiDefinitionInfo' description: Information about the formal API definition for the app. apiManagementConfig: $ref: '#/definitions/ApiManagementConfig' description: Azure API management settings linked to the app. autoSwapSlotName: type: string description: Auto-swap slot name. localMySqlEnabled: type: boolean description: true to enable local MySQL; otherwise, false. default: false managedServiceIdentityId: type: integer format: int32 description: Managed Service Identity Id xManagedServiceIdentityId: type: integer format: int32 description: Explicit Managed Service Identity Id keyVaultReferenceIdentity: type: string description: Identity to use for Key Vault Reference authentication. ipSecurityRestrictions: type: array description: IP security restrictions for main. items: $ref: '#/definitions/IpSecurityRestriction' x-ms-identifiers: - name ipSecurityRestrictionsDefaultAction: $ref: '#/definitions/DefaultAction' description: Default action for main access restriction if no rules are matched. scmIpSecurityRestrictions: type: array description: IP security restrictions for scm. items: $ref: '#/definitions/IpSecurityRestriction' x-ms-identifiers: - name scmIpSecurityRestrictionsDefaultAction: $ref: '#/definitions/DefaultAction' description: Default action for scm access restriction if no rules are matched. scmIpSecurityRestrictionsUseMain: type: boolean description: IP security restrictions for scm to use main. http20Enabled: type: boolean description: 'Http20Enabled: configures a web site to allow clients to connect over http2.0' default: true http20ProxyFlag: type: integer format: int32 description: 'Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only.' default: 0 minTlsVersion: $ref: '#/definitions/SupportedTlsVersions' description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' minTlsCipherSuite: $ref: '#/definitions/TlsCipherSuites' description: The minimum strength TLS cipher suite allowed for an application scmMinTlsVersion: $ref: '#/definitions/SupportedTlsVersions' description: 'ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site' ftpsState: $ref: '#/definitions/FtpsState' description: State of FTP / FTPS service preWarmedInstanceCount: type: integer format: int32 description: 'Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans' minimum: 0 maximum: 10 functionAppScaleLimit: type: integer format: int32 description: 'Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans' minimum: 0 elasticWebAppScaleLimit: type: integer format: int32 description: 'Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true' minimum: 0 healthCheckPath: type: string description: Health check path functionsRuntimeScaleMonitoringEnabled: type: boolean description: 'Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status.' websiteTimeZone: type: string description: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones minimumElasticInstanceCount: type: integer format: int32 description: 'Number of minimum instance count for a site This setting only applies to the Elastic Plans' minimum: 0 maximum: 20 azureStorageAccounts: type: object description: List of Azure Storage Accounts. additionalProperties: $ref: '#/definitions/AzureStorageInfoValue' publicNetworkAccess: type: string description: Property to allow or block all public traffic. AppServiceEnvironmentCollection: type: object description: Collection of App Service Environments. properties: value: type: array description: The AppServiceEnvironmentResource items on this page items: $ref: '#/definitions/AppServiceEnvironmentResource' nextLink: type: string format: uri description: The link to the next page of items required: - value SiteDnsConfig: type: object properties: dnsServers: type: array description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. items: type: string dnsAltServer: type: string description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. dnsRetryAttemptTimeout: type: integer format: int32 description: 'Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3.' dnsRetryAttemptCount: type: integer format: int32 description: 'Total number of retries for dns lookup. Allowed range: 1-5. Default is 3.' dnsMaxCacheTimeout: type: integer format: int32 description: 'Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled.' dnsLegacySortOrder: type: boolean description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. readOnly: true PrivateLinkResourcesWrapper: type: object description: Wrapper for a collection of private link resources properties: value: type: array items: $ref: '#/definitions/PrivateLinkResource' required: - value UserAssignedIdentity: type: object description: User Assigned identity. properties: principalId: type: string description: Principal Id of user assigned identity readOnly: true clientId: type: string description: Client Id of user assigned identity readOnly: true Usage: type: object description: Usage of the quota resource. properties: properties: $ref: '#/definitions/UsageProperties' description: Usage resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/definitions/ProxyOnlyResource' VirtualNetworkProfile: type: object description: Specification for using a Virtual Network. properties: id: type: string description: Resource id of the Virtual Network. name: type: string description: Name of the Virtual Network (read-only). readOnly: true type: type: string description: Resource type of the Virtual Network (read-only). readOnly: true subnet: type: string description: Subnet within the Virtual Network. required: - id WorkerPool: type: object description: Worker pool of an App Service Environment. properties: workerSizeId: type: integer format: int32 description: Worker size ID for referencing this worker pool. computeMode: $ref: '#/definitions/ComputeModeOptions' description: Shared or dedicated app hosting. workerSize: type: string description: VM size of the worker pool instances. workerCount: type: integer format: int32 description: Number of instances in the worker pool. instanceNames: type: array description: Names of all instances in the worker pool (read only). items: type: string readOnly: true VirtualIPMapping: type: object description: Virtual IP mapping. properties: virtualIP: type: string description: Virtual IP address. internalHttpPort: type: integer format: int32 description: Internal HTTP port. internalHttpsPort: type: integer format: int32 description: Internal HTTPS port. inUse: type: boolean description: Is virtual IP mapping in use. serviceName: type: string description: name of the service that virtual IP is assigned to HostingEnvironmentProfile: type: object description: Specification for an App Service Environment to use for this resource. properties: id: type: string description: Resource ID of the App Service Environment. name: type: string description: Name of the App Service Environment. readOnly: true type: type: string description: Resource type of the App Service Environment. readOnly: true AppServicePlan: type: object description: App Service plan. properties: properties: $ref: '#/definitions/AppServicePlanProperties' description: AppServicePlan resource specific properties x-ms-client-flatten: true sku: $ref: '#/definitions/SkuDescription' description: Description of a SKU for a scalable resource. extendedLocation: $ref: '#/definitions/ExtendedLocation' description: Extended Location. kind: type: string description: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. identity: $ref: '#/definitions/ManagedServiceIdentity' description: Managed service identity. allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource UsageState: type: string description: State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded x-ms-enum: name: UsageState modelAsString: false Experiments: type: object description: Routing rules in production experiments. properties: rampUpRules: type: array description: List of ramp-up rules. items: $ref: '#/definitions/RampUpRule' x-ms-identifiers: - name InboundEnvironmentEndpoint: type: object description: The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment. properties: description: type: string description: Short text describing the purpose of the network traffic. endpoints: type: array description: The IP addresses that network traffic will originate from in cidr notation. items: type: string ports: type: array description: The ports that network traffic will arrive to the App Service Environment at. items: type: string FunctionsDeploymentStorage: type: object description: Storage for deployed package used by the function app. properties: type: $ref: '#/definitions/FunctionsDeploymentStorageType' description: 'Property to select Azure Storage type. Available options: blobContainer.' value: type: string format: uri description: 'Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/.' authentication: $ref: '#/definitions/FunctionsDeploymentStorageAuthentication' description: Authentication method to access the storage account for deployment. securityDefinitions: azure_auth: type: oauth2 description: Azure Active Directory OAuth2 Flow. flow: implicit authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize scopes: user_impersonation: impersonate your user account