Microsoft.Web (stable:2016-09-01)

2025/09/30 • 68 new, 68 deleted methods

AppServiceEnvironments_List (new)
Description :  Get all App Service Environments for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListByResourceGroup (new)
Description :  Get all App Service Environments in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_Get (new)
Description :  Get the properties of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}
AppServiceEnvironments_CreateOrUpdate (new)
Description :  Create or update an App Service Environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
hostingEnvironmentEnvelope:
{
Description: Configuration details of the App Service Environment. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_Delete (new)
Description :  Delete an App Service Environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
forceDelete:
{
Description: Specify true to force the deletion even if the App Service Environment contains resources. The default is false. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_Update (new)
Description :  Create or update an App Service Environment.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
hostingEnvironmentEnvelope:
{
Description: Configuration details of the App Service Environment. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_ListCapacities (new)
Description :  Get the used, available, and total worker capacity an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListVips (new)
Description :  Get IP addresses assigned to an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceIpAddress:
{
Description: Main public virtual IP. ,
Required: False ,
}
string ,
internalIpAddress:
{
Description: Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode. ,
Required: False ,
}
string ,
outboundIpAddresses:
{
Description: IP addresses appearing on outbound connections. ,
Required: False ,
}
[
string ,
]
,
vipMappings:
{
Description: Additional virtual IPs. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
}
AppServiceEnvironments_ListDiagnostics (new)
Description :  Get diagnostic information for an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name/identifier of the diagnostics. ,
Required: False ,
}
string ,
diagnosicsOutput:
{
Description: Diagnostics output. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_GetDiagnosticsItem (new)
Description :  Get a diagnostics item for an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
diagnosticsName:
{
Description: Name of the diagnostics item. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name/identifier of the diagnostics. ,
Required: False ,
}
string ,
diagnosicsOutput:
{
Description: Diagnostics output. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMetricDefinitions (new)
Description :  Get global metric definitions of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: MetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain. ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListMetrics (new)
Description :  Get global metrics of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRolePools (new)
Description :  Get all multi-role pools.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_GetMultiRolePool (new)
Description :  Get properties of a multi-role pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AppServiceEnvironments_CreateOrUpdateMultiRolePool (new)
Description :  Create or update a multi-role pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
multiRolePoolEnvelope:
{
Description: Properties of the multi-role pool. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_UpdateMultiRolePool (new)
Description :  Create or update a multi-role pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
multiRolePoolEnvelope:
{
Description: Properties of the multi-role pool. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions (new)
Description :  Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
instance:
{
Description: Name of the instance in the multi-role pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceMetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain . ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
resourceUri:
{
Description: Resource URI. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRolePoolInstanceMetrics (new)
Description :  Get metrics for a specific instance of a multi-role pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
instance:
{
Description: Name of the instance in the multi-role pool. ,
Required: True ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRoleMetricDefinitions (new)
Description :  Get metric definitions for a multi-role pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceMetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain . ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
resourceUri:
{
Description: Resource URI. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRoleMetrics (new)
Description :  Get metrics for a multi-role pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
startTime:
{
Description: Beginning time of the metrics query. ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the metrics query. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time granularity of the metrics query. ,
Required: False ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRolePoolSkus (new)
Description :  Get available SKUs for scaling a multi-role pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
resourceType:
{
Description: Resource type that this SKU applies to. ,
Required: False ,
}
string ,
sku:
{
Description: Name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
capacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRoleUsages (new)
Description :  Get usage metrics for a multi-role pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Usage resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Friendly name shown in the UI. ,
Required: False ,
}
string ,
name:
{
Description: Name of the quota. ,
Required: False ,
}
string ,
resourceName:
{
Description: Name of the quota resource. ,
Required: False ,
}
string ,
unit:
{
Description: Units of measurement for the quota resource. ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the resource counter. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The resource limit. ,
Format: int64 ,
Required: False ,
}
integer ,
nextResetTime:
{
Description: Next reset time for the resource counter. ,
Format: date-time ,
Required: False ,
}
string ,
computeMode:
{
Description: Compute mode used for this usage. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
siteMode:
{
Description: Site mode used for this usage. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListOperations (new)
Description :  List all currently running operations on the App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Operation ID. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the operation. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Any errors associate with the operation. ,
Required: False ,
}
[
{
extendedCode:
{
Description: Type of error. ,
Required: False ,
}
string ,
messageTemplate:
{
Description: Message template. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the template. ,
Required: False ,
}
[
string ,
]
,
innerErrors:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: Basic error code. ,
Required: False ,
}
string ,
message:
{
Description: Any details of the error. ,
Required: False ,
}
string ,
}
,
]
,
createdTime:
{
Description: Time when operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Time when operation has been updated. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time when operation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
geoMasterOperationId:
{
Description: Applicable only for stamp operation ids. ,
Format: uuid ,
Required: False ,
}
string ,
}
AppServiceEnvironments_Reboot (new)
Description :  Reboot all machines in an App Service Environment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_Resume (new)
Description :  Resume an App Service Environment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListAppServicePlans (new)
Description :  Get all App Service plans in an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWebApps (new)
Description :  Get all apps in an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Comma separated list of app properties to include. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_Suspend (new)
Description :  Suspend an App Service Environment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListUsages (new)
Description :  Get global usage metrics of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
unit:
{
Description: Units of measurement for the quota resource. ,
Required: False ,
}
string ,
nextResetTime:
{
Description: Next reset time for the resource counter. ,
Format: date-time ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the resource counter. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The resource limit. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Quota name. ,
Required: False ,
}
{
value:
{
Description: Non-localized name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWorkerPools (new)
Description :  Get all worker pools of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_GetWorkerPool (new)
Description :  Get properties of a worker pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AppServiceEnvironments_CreateOrUpdateWorkerPool (new)
Description :  Create or update a worker pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
workerPoolEnvelope:
{
Description: Properties of the worker pool. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_UpdateWorkerPool (new)
Description :  Create or update a worker pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
workerPoolEnvelope:
{
Description: Properties of the worker pool. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions (new)
Description :  Get metric definitions for a specific instance of a worker pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
instance:
{
Description: Name of the instance in the worker pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceMetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain . ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
resourceUri:
{
Description: Resource URI. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWorkerPoolInstanceMetrics (new)
Description :  Get metrics for a specific instance of a worker pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
instance:
{
Description: Name of the instance in the worker pool. ,
Required: True ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWebWorkerMetricDefinitions (new)
Description :  Get metric definitions for a worker pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceMetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain . ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
resourceUri:
{
Description: Resource URI. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWebWorkerMetrics (new)
Description :  Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWorkerPoolSkus (new)
Description :  Get available SKUs for scaling a worker pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
resourceType:
{
Description: Resource type that this SKU applies to. ,
Required: False ,
}
string ,
sku:
{
Description: Name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
capacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWebWorkerUsages (new)
Description :  Get usage metrics for a worker pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Usage resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Friendly name shown in the UI. ,
Required: False ,
}
string ,
name:
{
Description: Name of the quota. ,
Required: False ,
}
string ,
resourceName:
{
Description: Name of the quota resource. ,
Required: False ,
}
string ,
unit:
{
Description: Units of measurement for the quota resource. ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the resource counter. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The resource limit. ,
Format: int64 ,
Required: False ,
}
integer ,
nextResetTime:
{
Description: Next reset time for the resource counter. ,
Format: date-time ,
Required: False ,
}
string ,
computeMode:
{
Description: Compute mode used for this usage. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
siteMode:
{
Description: Site mode used for this usage. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_List (new)
Description :  Get all App Service plans for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms
{
detailed:
{
Description: Specify true to return all App Service plan properties. The default is false, which returns a subset of the properties. Retrieval of all properties may increase the API latency. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_ListByResourceGroup (new)
Description :  Get all App Service plans in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_Get (new)
Description :  Get an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (404)

{}
AppServicePlans_CreateOrUpdate (new)
Description :  Creates or updates an App Service Plan.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
appServicePlan:
{
Description: Details of the App Service plan. ,
Required: True ,
}
{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AppServicePlans_Delete (new)
Description :  Delete an App Service plan.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
AppServicePlans_Update (new)
Description :  Creates or updates an App Service Plan.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
appServicePlan:
{
Description: Details of the App Service plan. ,
Required: True ,
}
{
properties:
{
Description: AppServicePlanPatchResource resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AppServicePlans_ListCapabilities (new)
Description :  List all capabilities of an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
AppServicePlans_GetHybridConnection (new)
Description :  Retrieve a Hybrid Connection in use in an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the Service Bus namespace. ,
Required: True ,
}
string ,
relayName:
{
Description: Name of the Service Bus relay. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: HybridConnection resource specific properties ,
Required: False ,
}
{
serviceBusNamespace:
{
Description: The name of the Service Bus namespace. ,
Required: False ,
}
string ,
relayName:
{
Description: The name of the Service Bus relay. ,
Required: False ,
}
string ,
relayArmUri:
{
Description: The ARM URI to the Service Bus relay. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname of the endpoint. ,
Required: False ,
}
string ,
port:
{
Description: The port of the endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
sendKeyName:
{
Description: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. ,
Required: False ,
}
string ,
sendKeyValue:
{
Description: The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead. ,
Required: False ,
}
string ,
serviceBusSuffix:
{
Description: The suffix for the service bus endpoint. By default this is .servicebus.windows.net ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_DeleteHybridConnection (new)
Description :  Delete a Hybrid Connection in use in an App Service plan.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the Service Bus namespace. ,
Required: True ,
}
string ,
relayName:
{
Description: Name of the Service Bus relay. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
AppServicePlans_ListHybridConnectionKeys (new)
Description :  Get the send key name and value of a Hybrid Connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the Service Bus namespace. ,
Required: True ,
}
string ,
relayName:
{
Description: The name of the Service Bus relay. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: HybridConnectionKey resource specific properties ,
Required: False ,
}
{
sendKeyName:
{
Description: The name of the send key. ,
Required: False ,
}
string ,
sendKeyValue:
{
Description: The value of the send key. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_ListWebAppsByHybridConnection (new)
Description :  Get all apps that use a Hybrid Connection in an App Service Plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the Hybrid Connection namespace. ,
Required: True ,
}
string ,
relayName:
{
Description: Name of the Hybrid Connection relay. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
string ,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_GetHybridConnectionPlanLimit (new)
Description :  Get the maximum number of Hybrid Connections allowed in an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: HybridConnectionLimits resource specific properties ,
Required: False ,
}
{
current:
{
Description: The current number of Hybrid Connections. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum number of Hybrid Connections allowed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
AppServicePlans_ListHybridConnections (new)
Description :  Retrieve all Hybrid Connections in use in an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: HybridConnection resource specific properties ,
Required: False ,
}
{
serviceBusNamespace:
{
Description: The name of the Service Bus namespace. ,
Required: False ,
}
string ,
relayName:
{
Description: The name of the Service Bus relay. ,
Required: False ,
}
string ,
relayArmUri:
{
Description: The ARM URI to the Service Bus relay. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname of the endpoint. ,
Required: False ,
}
string ,
port:
{
Description: The port of the endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
sendKeyName:
{
Description: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. ,
Required: False ,
}
string ,
sendKeyValue:
{
Description: The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead. ,
Required: False ,
}
string ,
serviceBusSuffix:
{
Description: The suffix for the service bus endpoint. By default this is .servicebus.windows.net ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_ListMetricDefintions (new)
Description :  Get metrics that can be queried for an App Service plan, and their definitions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceMetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain . ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
resourceUri:
{
Description: Resource URI. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_ListMetrics (new)
Description :  Get metrics for an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_RestartWebApps (new)
Description :  Restart all apps in an App Service plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
softRestart:
{
Description: Specify true to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
AppServicePlans_ListWebApps (new)
Description :  Get all apps associated with an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list ,
Required: False ,
}
string ,
$filter:
{
Description: Supported filter: $filter=state eq running. Returns only web apps that are currently running ,
Required: False ,
}
string ,
$top:
{
Description: List page size. If specified, results are paged. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_GetServerFarmSkus (new)
Description :  Gets all selectable SKUs for a given App Service Plan
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
AppServicePlans_ListUsages (new)
Description :  Gets server farm usage information
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
$filter:
{
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'). ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
unit:
{
Description: Units of measurement for the quota resource. ,
Required: False ,
}
string ,
nextResetTime:
{
Description: Next reset time for the resource counter. ,
Format: date-time ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the resource counter. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The resource limit. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Quota name. ,
Required: False ,
}
{
value:
{
Description: Non-localized name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_ListVnets (new)
Description :  Get all Virtual Networks associated with an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetInfo resource specific properties ,
Required: False ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Format: byte ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_GetVnetFromServerFarm (new)
Description :  Get a Virtual Network associated with an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetInfo resource specific properties ,
Required: False ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Format: byte ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
AppServicePlans_GetVnetGateway (new)
Description :  Get a Virtual Network gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Name of the gateway. Only the 'primary' gateway is supported. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}
AppServicePlans_UpdateVnetGateway (new)
Description :  Update a Virtual Network gateway.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Name of the gateway. Only the 'primary' gateway is supported. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Definition of the gateway. ,
Required: True ,
}
{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}
AppServicePlans_ListRoutesForVnet (new)
Description :  Get all routes that are associated with a Virtual Network in an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
AppServicePlans_GetRouteForVnet (new)
Description :  Get a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the Virtual Network route. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{}
AppServicePlans_CreateOrUpdateVnetRoute (new)
Description :  Create or update a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the Virtual Network route. ,
Required: True ,
}
string ,
route:
{
Description: Definition of the Virtual Network route. ,
Required: True ,
}
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}
AppServicePlans_DeleteVnetRoute (new)
Description :  Delete a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the Virtual Network route. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
AppServicePlans_UpdateVnetRoute (new)
Description :  Create or update a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the Virtual Network route. ,
Required: True ,
}
string ,
route:
{
Description: Definition of the Virtual Network route. ,
Required: True ,
}
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}
AppServicePlans_RebootWorker (new)
Description :  Reboot a worker machine in an App Service plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
workerName:
{
Description: Name of worker machine, which typically starts with RD. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
AppServiceEnvironments_List (removed)
Description :  Get all App Service Environments for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListByResourceGroup (removed)
Description :  Get all App Service Environments in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_Get (removed)
Description :  Get the properties of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}
AppServiceEnvironments_CreateOrUpdate (removed)
Description :  Create or update an App Service Environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
hostingEnvironmentEnvelope:
{
Description: Configuration details of the App Service Environment. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_Delete (removed)
Description :  Delete an App Service Environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
forceDelete:
{
Description: Specify true to force the deletion even if the App Service Environment contains resources. The default is false. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_Update (removed)
Description :  Create or update an App Service Environment.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
hostingEnvironmentEnvelope:
{
Description: Configuration details of the App Service Environment. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
location:
{
Description: Location of the App Service Environment, e.g. "West US". ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of the App Service Environment. ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
vnetName:
{
Description: Name of the Virtual Network for the App Service Environment. ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the Virtual Network. ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the Virtual Network. ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Virtual Network (read-only). ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Virtual Network (read-only). ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the Virtual Network. ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large". ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances. ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. ,
Required: True ,
}
[
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the App Service Environment, e.g. "Standard". ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the App Service Environment, e.g. "S0". ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the App Service Environment. ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on the App Service Environment. ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends. ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for the App Service Environment. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the App Service Environment. ,
Required: False ,
}
[
{
action:
{
Description: Action object. ,
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of network access control entry. ,
Required: False ,
}
string ,
order:
{
Description: Order of precedence. ,
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Description: Remote subnet. ,
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the App Service Environment is healthy. ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the App Service Environment. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service Environment. ,
Required: False ,
}
string ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultFrontEndScaleFactor:
{
Description: Default Scale Factor for FrontEnds. ,
Format: int32 ,
Required: False ,
}
integer ,
apiManagementAccountId:
{
Description: API Management Account associated with the App Service Environment. ,
Required: False ,
}
string ,
suspended:
{
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). ,
Required: False ,
}
boolean ,
dynamicCacheEnabled:
{
Description: True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the App Service Environment. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
userWhitelistedIpRanges:
{
Description: User added list of IP Ranges allowed on ASE db ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_ListCapacities (removed)
Description :  Get the used, available, and total worker capacity an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of the stamp. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...). ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit. ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/dedicated workers. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines. ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
}
,
Required: False ,
}
enum ,
workerSizeId:
{
Description: Size ID of machines: 0 - Small 1 - Medium 2 - Large ,
Format: int32 ,
Required: False ,
}
integer ,
excludeFromCapacityAllocation:
{
Description: If true, it includes basic apps. Basic apps are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: true if capacity is applicable for all apps; otherwise, false. ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListVips (removed)
Description :  Get IP addresses assigned to an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceIpAddress:
{
Description: Main public virtual IP. ,
Required: False ,
}
string ,
internalIpAddress:
{
Description: Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode. ,
Required: False ,
}
string ,
outboundIpAddresses:
{
Description: IP addresses appearing on outbound connections. ,
Required: False ,
}
[
string ,
]
,
vipMappings:
{
Description: Additional virtual IPs. ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address. ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port. ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port. ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is virtual IP mapping in use. ,
Required: False ,
}
boolean ,
}
,
]
,
}
AppServiceEnvironments_ListDiagnostics (removed)
Description :  Get diagnostic information for an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name/identifier of the diagnostics. ,
Required: False ,
}
string ,
diagnosicsOutput:
{
Description: Diagnostics output. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_GetDiagnosticsItem (removed)
Description :  Get a diagnostics item for an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
diagnosticsName:
{
Description: Name of the diagnostics item. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name/identifier of the diagnostics. ,
Required: False ,
}
string ,
diagnosicsOutput:
{
Description: Diagnostics output. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMetricDefinitions (removed)
Description :  Get global metric definitions of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: MetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain. ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListMetrics (removed)
Description :  Get global metrics of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRolePools (removed)
Description :  Get all multi-role pools.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_GetMultiRolePool (removed)
Description :  Get properties of a multi-role pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AppServiceEnvironments_CreateOrUpdateMultiRolePool (removed)
Description :  Create or update a multi-role pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
multiRolePoolEnvelope:
{
Description: Properties of the multi-role pool. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_UpdateMultiRolePool (removed)
Description :  Create or update a multi-role pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
multiRolePoolEnvelope:
{
Description: Properties of the multi-role pool. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions (removed)
Description :  Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
instance:
{
Description: Name of the instance in the multi-role pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceMetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain . ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
resourceUri:
{
Description: Resource URI. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRolePoolInstanceMetrics (removed)
Description :  Get metrics for a specific instance of a multi-role pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
instance:
{
Description: Name of the instance in the multi-role pool. ,
Required: True ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRoleMetricDefinitions (removed)
Description :  Get metric definitions for a multi-role pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceMetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain . ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
resourceUri:
{
Description: Resource URI. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRoleMetrics (removed)
Description :  Get metrics for a multi-role pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
startTime:
{
Description: Beginning time of the metrics query. ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the metrics query. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time granularity of the metrics query. ,
Required: False ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRolePoolSkus (removed)
Description :  Get available SKUs for scaling a multi-role pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
resourceType:
{
Description: Resource type that this SKU applies to. ,
Required: False ,
}
string ,
sku:
{
Description: Name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
capacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListMultiRoleUsages (removed)
Description :  Get usage metrics for a multi-role pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Usage resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Friendly name shown in the UI. ,
Required: False ,
}
string ,
name:
{
Description: Name of the quota. ,
Required: False ,
}
string ,
resourceName:
{
Description: Name of the quota resource. ,
Required: False ,
}
string ,
unit:
{
Description: Units of measurement for the quota resource. ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the resource counter. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The resource limit. ,
Format: int64 ,
Required: False ,
}
integer ,
nextResetTime:
{
Description: Next reset time for the resource counter. ,
Format: date-time ,
Required: False ,
}
string ,
computeMode:
{
Description: Compute mode used for this usage. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
siteMode:
{
Description: Site mode used for this usage. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListOperations (removed)
Description :  List all currently running operations on the App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Operation ID. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the operation. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Any errors associate with the operation. ,
Required: False ,
}
[
{
extendedCode:
{
Description: Type of error. ,
Required: False ,
}
string ,
messageTemplate:
{
Description: Message template. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the template. ,
Required: False ,
}
[
string ,
]
,
innerErrors:
{
Description: Inner errors. ,
Required: False ,
}
[
string ,
]
,
code:
{
Description: Basic error code. ,
Required: False ,
}
string ,
message:
{
Description: Any details of the error. ,
Required: False ,
}
string ,
}
,
]
,
createdTime:
{
Description: Time when operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Time when operation has been updated. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Time when operation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
geoMasterOperationId:
{
Description: Applicable only for stamp operation ids. ,
Format: uuid ,
Required: False ,
}
string ,
}
AppServiceEnvironments_Reboot (removed)
Description :  Reboot all machines in an App Service Environment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_Resume (removed)
Description :  Resume an App Service Environment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListAppServicePlans (removed)
Description :  Get all App Service plans in an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWebApps (removed)
Description :  Get all apps in an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Comma separated list of app properties to include. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_Suspend (removed)
Description :  Suspend an App Service Environment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListUsages (removed)
Description :  Get global usage metrics of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
unit:
{
Description: Units of measurement for the quota resource. ,
Required: False ,
}
string ,
nextResetTime:
{
Description: Next reset time for the resource counter. ,
Format: date-time ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the resource counter. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The resource limit. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Quota name. ,
Required: False ,
}
{
value:
{
Description: Non-localized name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWorkerPools (removed)
Description :  Get all worker pools of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_GetWorkerPool (removed)
Description :  Get properties of a worker pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AppServiceEnvironments_CreateOrUpdateWorkerPool (removed)
Description :  Create or update a worker pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
workerPoolEnvelope:
{
Description: Properties of the worker pool. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_UpdateWorkerPool (removed)
Description :  Create or update a worker pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
workerPoolEnvelope:
{
Description: Properties of the worker pool. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
workerSizeId:
{
Description: Worker size ID for referencing this worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated app hosting. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: VM size of the worker pool instances. ,
Required: False ,
}
string ,
workerCount:
{
Description: Number of instances in the worker pool. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceNames:
{
Description: Names of all instances in the worker pool (read only). ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions (removed)
Description :  Get metric definitions for a specific instance of a worker pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
instance:
{
Description: Name of the instance in the worker pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceMetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain . ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
resourceUri:
{
Description: Resource URI. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWorkerPoolInstanceMetrics (removed)
Description :  Get metrics for a specific instance of a worker pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
instance:
{
Description: Name of the instance in the worker pool. ,
Required: True ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWebWorkerMetricDefinitions (removed)
Description :  Get metric definitions for a worker pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceMetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain . ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
resourceUri:
{
Description: Resource URI. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWebWorkerMetrics (removed)
Description :  Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWorkerPoolSkus (removed)
Description :  Get available SKUs for scaling a worker pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
resourceType:
{
Description: Resource type that this SKU applies to. ,
Required: False ,
}
string ,
sku:
{
Description: Name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
capacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceEnvironments_ListWebWorkerUsages (removed)
Description :  Get usage metrics for a worker pool of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of the worker pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Usage resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Friendly name shown in the UI. ,
Required: False ,
}
string ,
name:
{
Description: Name of the quota. ,
Required: False ,
}
string ,
resourceName:
{
Description: Name of the quota resource. ,
Required: False ,
}
string ,
unit:
{
Description: Units of measurement for the quota resource. ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the resource counter. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The resource limit. ,
Format: int64 ,
Required: False ,
}
integer ,
nextResetTime:
{
Description: Next reset time for the resource counter. ,
Format: date-time ,
Required: False ,
}
string ,
computeMode:
{
Description: Compute mode used for this usage. ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
siteMode:
{
Description: Site mode used for this usage. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_List (removed)
Description :  Get all App Service plans for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms
{
detailed:
{
Description: Specify true to return all App Service plan properties. The default is false, which returns a subset of the properties. Retrieval of all properties may increase the API latency. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_ListByResourceGroup (removed)
Description :  Get all App Service plans in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_Get (removed)
Description :  Get an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (404)

{}
AppServicePlans_CreateOrUpdate (removed)
Description :  Creates or updates an App Service Plan.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
appServicePlan:
{
Description: Details of the App Service plan. ,
Required: True ,
}
{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AppServicePlans_Delete (removed)
Description :  Delete an App Service plan.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
AppServicePlans_Update (removed)
Description :  Creates or updates an App Service Plan.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
appServicePlan:
{
Description: Details of the App Service plan. ,
Required: True ,
}
{
properties:
{
Description: AppServicePlanPatchResource resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name for the App Service plan. ,
Required: True ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service plan. ,
Required: False ,
}
string ,
status:
{
Description: App Service plan status. ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: App Service plan subscription. ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service plan administration site. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service plan. ,
Required: False ,
}
string ,
perSiteScaling:
{
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. ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of apps assigned to this App Service plan. ,
Format: int32 ,
Required: False ,
}
integer ,
isSpot:
{
Description: If true, this App Service Plan owns spot instances. ,
Required: False ,
}
boolean ,
spotExpirationTime:
{
Description: The time when the server farm expires. Valid only if it is a spot server farm. ,
Format: date-time ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the App Service plan. ,
Required: False ,
}
string ,
reserved:
{
Description: If Linux app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
targetWorkerCount:
{
Description: Scaling worker count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetWorkerSizeId:
{
Description: Scaling worker size ID. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the App Service Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Description of a SKU for a scalable resource. ,
Required: False ,
}
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
skuCapacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AppServicePlans_ListCapabilities (removed)
Description :  List all capabilities of an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
AppServicePlans_GetHybridConnection (removed)
Description :  Retrieve a Hybrid Connection in use in an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the Service Bus namespace. ,
Required: True ,
}
string ,
relayName:
{
Description: Name of the Service Bus relay. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: HybridConnection resource specific properties ,
Required: False ,
}
{
serviceBusNamespace:
{
Description: The name of the Service Bus namespace. ,
Required: False ,
}
string ,
relayName:
{
Description: The name of the Service Bus relay. ,
Required: False ,
}
string ,
relayArmUri:
{
Description: The ARM URI to the Service Bus relay. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname of the endpoint. ,
Required: False ,
}
string ,
port:
{
Description: The port of the endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
sendKeyName:
{
Description: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. ,
Required: False ,
}
string ,
sendKeyValue:
{
Description: The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead. ,
Required: False ,
}
string ,
serviceBusSuffix:
{
Description: The suffix for the service bus endpoint. By default this is .servicebus.windows.net ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_DeleteHybridConnection (removed)
Description :  Delete a Hybrid Connection in use in an App Service plan.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the Service Bus namespace. ,
Required: True ,
}
string ,
relayName:
{
Description: Name of the Service Bus relay. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
AppServicePlans_ListHybridConnectionKeys (removed)
Description :  Get the send key name and value of a Hybrid Connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the Service Bus namespace. ,
Required: True ,
}
string ,
relayName:
{
Description: The name of the Service Bus relay. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: HybridConnectionKey resource specific properties ,
Required: False ,
}
{
sendKeyName:
{
Description: The name of the send key. ,
Required: False ,
}
string ,
sendKeyValue:
{
Description: The value of the send key. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_ListWebAppsByHybridConnection (removed)
Description :  Get all apps that use a Hybrid Connection in an App Service Plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Name of the Hybrid Connection namespace. ,
Required: True ,
}
string ,
relayName:
{
Description: Name of the Hybrid Connection relay. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
string ,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_GetHybridConnectionPlanLimit (removed)
Description :  Get the maximum number of Hybrid Connections allowed in an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: HybridConnectionLimits resource specific properties ,
Required: False ,
}
{
current:
{
Description: The current number of Hybrid Connections. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum number of Hybrid Connections allowed. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
AppServicePlans_ListHybridConnections (removed)
Description :  Retrieve all Hybrid Connections in use in an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: HybridConnection resource specific properties ,
Required: False ,
}
{
serviceBusNamespace:
{
Description: The name of the Service Bus namespace. ,
Required: False ,
}
string ,
relayName:
{
Description: The name of the Service Bus relay. ,
Required: False ,
}
string ,
relayArmUri:
{
Description: The ARM URI to the Service Bus relay. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname of the endpoint. ,
Required: False ,
}
string ,
port:
{
Description: The port of the endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
sendKeyName:
{
Description: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. ,
Required: False ,
}
string ,
sendKeyValue:
{
Description: The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead. ,
Required: False ,
}
string ,
serviceBusSuffix:
{
Description: The suffix for the service bus endpoint. By default this is .servicebus.windows.net ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_ListMetricDefintions (removed)
Description :  Get metrics that can be queried for an App Service plan, and their definitions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceMetricDefinition resource specific properties ,
Required: False ,
}
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type. ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain . ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current time grain. ,
Required: False ,
}
string ,
}
,
]
,
resourceUri:
{
Description: Resource URI. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_ListMetrics (removed)
Description :  Get metrics for an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
details:
{
Description: Specify true to include instance details. The default is false. ,
Required: False ,
}
boolean ,
$filter:
{
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 ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of metric. ,
Required: False ,
}
{
value:
{
Description: metric name value. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: Value timestamp. ,
Required: False ,
}
string ,
average:
{
Description: Value average. ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum. ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum. ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total. ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count. ,
Format: float ,
Required: False ,
}
number ,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
properties:
{
Description: Resource metric properties collection. ,
Required: False ,
}
[
{
key:
{
Description: Key for resource metric property. ,
Required: False ,
}
string ,
value:
{
Description: Value of pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_RestartWebApps (removed)
Description :  Restart all apps in an App Service plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
softRestart:
{
Description: Specify true to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
AppServicePlans_ListWebApps (removed)
Description :  Get all apps associated with an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list ,
Required: False ,
}
string ,
$filter:
{
Description: Supported filter: $filter=state eq running. Returns only web apps that are currently running ,
Required: False ,
}
string ,
$top:
{
Description: List page size. If specified, results are paged. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
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. ,
Required: False ,
}
[
string ,
]
,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
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: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: IP security restrictions. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. ,
Required: True ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
}
,
]
,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
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. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
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. ,
Required: True ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
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. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
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}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
ignoreQuotas:
{
Description: true if quotas should be ignored; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
snapshotInfo:
{
Description: If specified during app creation, the app is created from a previous snapshot. ,
Required: False ,
}
{
properties:
{
Description: SnapshotRecoveryRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app recovery should be attempted, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoveryTarget:
{
Description: Specifies the web app that snapshot contents will be written to. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the target app. /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. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the recovery operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_GetServerFarmSkus (removed)
Description :  Gets all selectable SKUs for a given App Service Plan
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
AppServicePlans_ListUsages (removed)
Description :  Gets server farm usage information
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
$filter:
{
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'). ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
unit:
{
Description: Units of measurement for the quota resource. ,
Required: False ,
}
string ,
nextResetTime:
{
Description: Next reset time for the resource counter. ,
Format: date-time ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the resource counter. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The resource limit. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Quota name. ,
Required: False ,
}
{
value:
{
Description: Non-localized name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServicePlans_ListVnets (removed)
Description :  Get all Virtual Networks associated with an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetInfo resource specific properties ,
Required: False ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Format: byte ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_GetVnetFromServerFarm (removed)
Description :  Get a Virtual Network associated with an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetInfo resource specific properties ,
Required: False ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Format: byte ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
AppServicePlans_GetVnetGateway (removed)
Description :  Get a Virtual Network gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Name of the gateway. Only the 'primary' gateway is supported. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}
AppServicePlans_UpdateVnetGateway (removed)
Description :  Update a Virtual Network gateway.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Name of the gateway. Only the 'primary' gateway is supported. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Definition of the gateway. ,
Required: True ,
}
{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}
AppServicePlans_ListRoutesForVnet (removed)
Description :  Get all routes that are associated with a Virtual Network in an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
AppServicePlans_GetRouteForVnet (removed)
Description :  Get a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the Virtual Network route. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{}
AppServicePlans_CreateOrUpdateVnetRoute (removed)
Description :  Create or update a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the Virtual Network route. ,
Required: True ,
}
string ,
route:
{
Description: Definition of the Virtual Network route. ,
Required: True ,
}
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}
AppServicePlans_DeleteVnetRoute (removed)
Description :  Delete a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the Virtual Network route. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
AppServicePlans_UpdateVnetRoute (removed)
Description :  Create or update a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the Virtual Network route. ,
Required: True ,
}
string ,
route:
{
Description: Definition of the Virtual Network route. ,
Required: True ,
}
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}
AppServicePlans_RebootWorker (removed)
Description :  Reboot a worker machine in an App Service plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
workerName:
{
Description: Name of worker machine, which typically starts with RD. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}