Microsoft.Web (stable:2025-03-01)

2025/10/14 • 692 new methods

AppServiceEnvironments_List (new)
Description :  Description for 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 ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListByResourceGroup (new)
Description :  Description for 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 ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_Get (new)
Description :  Description for 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 ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_CreateOrUpdate (new)
Description :  Description for 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 ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
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: Core resource properties ,
Required: False ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Location header for asynchronous response. ,
}
string ,
}
,
$schema:
{
Description: App Service Environment ARM resource. ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_Delete (new)
Description :  Description for 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 (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_Update (new)
Description :  Description for 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 ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
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: Core resource properties ,
Required: False ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
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 ,
virtualNetwork:
{
Description: Description of the Virtual Network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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. ,
Web, 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 ,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the App Service Environment. ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in the App Service Environment. ,
Format: int32 ,
Required: False ,
}
integer ,
frontEndScaleFactor:
{
Description: Scale factor for front-ends. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
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 ip ranges to whitelist on ASE db ,
Required: False ,
}
[
string ,
]
,
hasLinuxWorkers:
{
Description: Flag that displays whether an ASE has linux workers or not ,
Required: False ,
}
boolean ,
upgradePreference:
{
Description: Upgrade Preference ,
Enum:
{
None: No preference on when this App Service Environment will be upgraded ,
Early: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' ,
Late: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' ,
Manual: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically ,
}
,
Required: False ,
}
enum ,
dedicatedHostCount:
{
Description: Dedicated Host Count ,
Format: int32 ,
Required: False ,
}
integer ,
zoneRedundant:
{
Description: Whether or not this App Service Environment is zone-redundant. ,
Required: False ,
}
boolean ,
customDnsSuffixConfiguration:
{
Description: Full view of the custom domain suffix configuration for ASEv3. ,
Required: False ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}
,
networkingConfiguration:
{
Description: Full view of networking configuration for an ASE. ,
Required: False ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}
,
upgradeAvailability:
{
Description: Whether an upgrade is available for this App Service Environment. ,
Enum:
{
None: No upgrade is currently available for this App Service Environment ,
Ready: An upgrade is ready to be manually initiated on this App Service Environment ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListCapacities (new)
Description :  Description for 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:
{
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
D1: No description available. ,
D2: No description available. ,
D3: No description available. ,
SmallV3: No description available. ,
MediumV3: No description available. ,
LargeV3: No description available. ,
NestedSmall: No description available. ,
NestedSmallLinux: No description available. ,
Default: 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 ,
isLinux:
{
Description: Is this a linux stamp capacity ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetVipInfo (new)
Description :  Description for 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)

{
properties:
{
Description: AddressResponse resource specific properties ,
Required: False ,
}
{
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 ,
serviceName:
{
Description: name of the service that virtual IP is assigned to ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ChangeVnet (new)
Description :  Description for Move an App Service Environment to a different VNET.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork
{
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 ,
vnetInfo:
{
Description: Details for the new virtual network. ,
Required: True ,
}
{
id:
{
Description: Resource id of the Virtual Network. ,
Required: True ,
}
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 ,
}
,
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 ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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 ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon 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 ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
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. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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. ,
VSTSRM: 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. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: 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 \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
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 ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
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 ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
]
,
supportCredentials:
{
Description: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. ,
Required: False ,
}
boolean ,
}
,
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 whitelisted 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 ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
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 ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
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 ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
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 except dataComponent. 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 ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
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 ,
}
,
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 ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} ,
Required: False ,
}
string ,
sku:
{
Description: Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
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 ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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 ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon 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 ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
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. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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. ,
VSTSRM: 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. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: 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 \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
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 ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
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 ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
]
,
supportCredentials:
{
Description: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. ,
Required: False ,
}
boolean ,
}
,
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 whitelisted 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 ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
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 ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
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 ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
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 except dataComponent. 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 ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
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 ,
}
,
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 ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} ,
Required: False ,
}
string ,
sku:
{
Description: Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetAseCustomDnsSuffixConfiguration (new)
Description :  Get Custom Dns Suffix configuration of an App Service Environment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix
{
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: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_UpdateAseCustomDnsSuffixConfiguration (new)
Description :  Update Custom Dns Suffix configuration of an App Service Environment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix
{
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 ,
customDnsSuffixConfiguration:
{
Required: True ,
}
{
properties:
{
Description: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
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: CustomDnsSuffixConfiguration resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Degraded: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningDetails:
{
Required: False ,
}
string ,
dnsSuffix:
{
Description: The default custom domain suffix to use for all sites deployed on the ASE. ,
Required: False ,
}
string ,
certificateUrl:
{
Description: The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_DeleteAseCustomDnsSuffixConfiguration (new)
Description :  Delete Custom Dns Suffix configuration of an App Service Environment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix
{
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)

{
$schema: object ,
}

⚐ Response (204)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetAseV3NetworkingConfiguration (new)
Description :  Description for Get networking configuration of an App Service Environment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking
{
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: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_UpdateAseNetworkingConfiguration (new)
Description :  Description for Update networking configuration of an App Service Environment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking
{
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 ,
aseNetworkingConfiguration:
{
Required: True ,
}
{
properties:
{
Description: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
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: AseV3NetworkingConfiguration resource specific properties ,
Required: False ,
}
{
windowsOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
linuxOutboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
externalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
internalInboundIpAddresses:
{
Required: False ,
}
[
string ,
]
,
allowNewPrivateEndpointConnections:
{
Description: Property to enable and disable new private endpoint connection creation on ASE ,
Required: False ,
}
boolean ,
ftpEnabled:
{
Description: Property to enable and disable FTP on ASEV3 ,
Required: False ,
}
boolean ,
remoteDebugEnabled:
{
Description: Property to enable and disable Remote Debug on ASEV3 ,
Required: False ,
}
boolean ,
inboundIpAddressOverride:
{
Description: Customer provided Inbound IP Address. Only able to be set on Ase create. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListDiagnostics (new)
Description :  Description for 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 ,
diagnosticsOutput:
{
Description: Diagnostics output. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetDiagnosticsItem (new)
Description :  Description for 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 ,
diagnosticsOutput:
{
Description: Diagnostics output. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints (new)
Description :  Description for Get the network endpoints of all inbound dependencies of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints
{
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 ,
}
[
{
description:
{
Description: Short text describing the purpose of the network traffic. ,
Required: False ,
}
string ,
endpoints:
{
Description: The IP addresses that network traffic will originate from in cidr notation. ,
Required: False ,
}
[
string ,
]
,
ports:
{
Description: The ports that network traffic will arrive to the App Service Environment at. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListMultiRolePools (new)
Description :  Description for 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetMultiRolePool (new)
Description :  Description for 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_CreateOrUpdateMultiRolePool (new)
Description :  Description for 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_UpdateMultiRolePool (new)
Description :  Description for 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions (new)
Description :  Description for 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 ,
}
{
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 ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListMultiRoleMetricDefinitions (new)
Description :  Description for 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 ,
}
{
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 ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListMultiRolePoolSkus (new)
Description :  Description for 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_TestUpgradeAvailableNotification (new)
Description :  Send a test notification that an upgrade is available for this App Service Environment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/testUpgradeAvailableNotification
{
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)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_Upgrade (new)
Description :  Description for Initiate an upgrade of an App Service Environment if one is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade
{
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 (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListMultiRoleUsages (new)
Description :  Description for 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 ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListOperations (new)
Description :  Description for 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 ,
]
,
details:
{
Description: Error Details. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The error target. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints (new)
Description :  Description for Get the network endpoints of all outbound dependencies of an App Service Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints
{
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 ,
}
[
{
category:
{
Description: The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints that the App Service Environment reaches the service at. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The IP Addresses and Ports used when connecting to DomainName. ,
Required: False ,
}
[
{
ipAddress:
{
Description: An IP Address that Domain Name currently resolves to. ,
Required: False ,
}
string ,
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
latency:
{
Description: The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress at this Port. ,
Format: double ,
Required: False ,
}
number ,
isAccessible:
{
Description: Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetPrivateEndpointConnectionList (new)
Description :  Description for Gets the list of private endpoints associated with a hosting environment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections
{
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: RemotePrivateEndpointConnectionARMResource resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: Private IPAddresses mapped to the remote private endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetPrivateEndpointConnection (new)
Description :  Description for Gets a private endpoint connection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
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: RemotePrivateEndpointConnectionARMResource resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: Private IPAddresses mapped to the remote private endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection (new)
Description :  Description for Approves or rejects a private endpoint connection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Required: True ,
}
string ,
privateEndpointWrapper:
{
Required: True ,
}
{
properties:
{
Description: RemotePrivateEndpointConnectionARMResource resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: Private IPAddresses mapped to the remote private endpoint ,
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: RemotePrivateEndpointConnectionARMResource resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: Private IPAddresses mapped to the remote private endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: RemotePrivateEndpointConnectionARMResource resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: Private IPAddresses mapped to the remote private endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_DeletePrivateEndpointConnection (new)
Description :  Description for Deletes a private endpoint connection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
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 ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (204)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetPrivateLinkResources (new)
Description :  Description for Gets the private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources
{
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:
{
Required: True ,
}
[
{
id:
{
Required: True ,
}
string ,
name:
{
Description: Name of a private link resource ,
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
properties:
{
Description: Properties of a private link resource ,
Required: True ,
}
{
groupId:
{
Description: GroupId of a private link resource ,
Required: False ,
}
string ,
requiredMembers:
{
Description: RequiredMembers of a private link resource ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: RequiredZoneNames of a private link resource ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_Reboot (new)
Description :  Description for 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 (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_Resume (new)
Description :  Description for 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 ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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 ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon 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 ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
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. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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. ,
VSTSRM: 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. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: 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 \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
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 ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
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 ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
]
,
supportCredentials:
{
Description: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. ,
Required: False ,
}
boolean ,
}
,
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 whitelisted 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 ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
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 ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
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 ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
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 except dataComponent. 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 ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
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 ,
}
,
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 ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} ,
Required: False ,
}
string ,
sku:
{
Description: Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
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 ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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 ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon 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 ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
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. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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. ,
VSTSRM: 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. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: 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 \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
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 ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
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 ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
]
,
supportCredentials:
{
Description: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. ,
Required: False ,
}
boolean ,
}
,
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 whitelisted 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 ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
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 ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
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 ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
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 except dataComponent. 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 ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
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 ,
}
,
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 ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} ,
Required: False ,
}
string ,
sku:
{
Description: Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListAppServicePlans (new)
Description :  Description for 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 ,
}
{
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 ,
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 ,
numberOfWorkers:
{
Description: The number of instances that are 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 ,
elasticScaleEnabled:
{
Description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku ,
Required: False ,
}
boolean ,
maximumElasticWorkerCount:
{
Description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
freeOfferExpirationTime:
{
Description: The time when the server farm free offer expires. ,
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 ,
isXenon:
{
Description: Obsolete: If Hyper-V container app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: If Hyper-V container 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 Plan. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
kubeEnvironmentProfile:
{
Description: Specification for the Kubernetes Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Kubernetes Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Kubernetes Environment. ,
Required: False ,
}
string ,
}
,
zoneRedundant:
{
Description: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. ,
Required: False ,
}
boolean ,
asyncScalingEnabled:
{
Description: If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling. ,
Required: False ,
}
boolean ,
planDefaultIdentity:
{
Description: Identity to use by platform for various features and integrations using managed identity. ,
Required: False ,
}
{
identityType:
{
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Required: False ,
}
string ,
}
,
isCustomMode:
{
Description: Whether this server farm is in custom mode. ,
Required: False ,
}
boolean ,
registryAdapters:
{
Description: Registry adapters associated with this App Service plan. ,
Required: False ,
}
[
{
registryKey:
{
Description: Registry key for the adapter. ,
Required: False ,
}
string ,
type:
{
Description: Type of the registry adapter. ,
Enum:
{
Binary: No description available. ,
String: No description available. ,
Expand_String: No description available. ,
Multi_String: No description available. ,
DWord: No description available. ,
QWord: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultSecretReference:
{
Description: Key vault reference to the value that will be placed in the registry location ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installScripts:
{
Description: Install scripts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the install script. ,
Required: False ,
}
string ,
source:
{
Description: Source of the install script. ,
Required: False ,
}
{
sourceUri:
{
Description: Install script source URI where the install script file will be fetched from. ,
Required: False ,
}
string ,
type:
{
Description: Type of the install script. ,
Enum:
{
RemoteAzureBlob: No description available. ,
PlatformStorage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
network:
{
Description: All network settings for the server farm. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
}
,
storageMounts:
{
Description: Storage mounts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage mount. ,
Required: False ,
}
string ,
type:
{
Description: Type of the storage mount. ,
Enum:
{
AzureFiles: No description available. ,
LocalStorage: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the fileshare/storage. ,
Required: False ,
}
string ,
destinationPath:
{
Description: Path on worker where storage will be mounted. ,
Required: False ,
}
string ,
credentialsKeyVaultReference:
{
Description: KV reference to the credentials to connect to the share. ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
rdpEnabled:
{
Description: If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled. ,
Required: False ,
}
boolean ,
}
,
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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}
,
]
,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListWebApps (new)
Description :  Description for 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 ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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 ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon 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 ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
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. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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. ,
VSTSRM: 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. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: 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 \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
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 ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
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 ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
]
,
supportCredentials:
{
Description: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. ,
Required: False ,
}
boolean ,
}
,
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 whitelisted 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 ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
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 ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
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 ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
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 except dataComponent. 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 ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
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 ,
}
,
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 ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} ,
Required: False ,
}
string ,
sku:
{
Description: Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_Suspend (new)
Description :  Description for 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 ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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 ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon 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 ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
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. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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. ,
VSTSRM: 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. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: 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 \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
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 ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
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 ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
]
,
supportCredentials:
{
Description: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. ,
Required: False ,
}
boolean ,
}
,
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 whitelisted 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 ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
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 ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
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 ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
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 except dataComponent. 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 ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
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 ,
}
,
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 ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} ,
Required: False ,
}
string ,
sku:
{
Description: Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
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 ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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 ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon 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 ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
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. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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. ,
VSTSRM: 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. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: 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 \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
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 ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
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 ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
]
,
supportCredentials:
{
Description: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. ,
Required: False ,
}
boolean ,
}
,
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 whitelisted 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 ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. ,
Format: int32 ,
Required: False ,
}
integer ,
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. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
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 ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
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 ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
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 except dataComponent. 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 ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
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 ,
}
,
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 ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} ,
Required: False ,
}
string ,
sku:
{
Description: Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListUsages (new)
Description :  Description for 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 ,
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 ,
$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 ,
}

⚐ 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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListWorkerPools (new)
Description :  Description for 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_GetWorkerPool (new)
Description :  Description for 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_CreateOrUpdateWorkerPool (new)
Description :  Description for 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_UpdateWorkerPool (new)
Description :  Description for 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions (new)
Description :  Description for 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 ,
}
{
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 ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListWebWorkerMetricDefinitions (new)
Description :  Description for 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 ,
}
{
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 ,
properties:
{
Description: Resource metric definition properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListWorkerPoolSkus (new)
Description :  Description for 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceEnvironments_ListWebWorkerUsages (new)
Description :  Description for 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 ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_List (new)
Description :  Description for 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 ,
}
{
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 ,
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 ,
numberOfWorkers:
{
Description: The number of instances that are 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 ,
elasticScaleEnabled:
{
Description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku ,
Required: False ,
}
boolean ,
maximumElasticWorkerCount:
{
Description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
freeOfferExpirationTime:
{
Description: The time when the server farm free offer expires. ,
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 ,
isXenon:
{
Description: Obsolete: If Hyper-V container app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: If Hyper-V container 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 Plan. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
kubeEnvironmentProfile:
{
Description: Specification for the Kubernetes Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Kubernetes Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Kubernetes Environment. ,
Required: False ,
}
string ,
}
,
zoneRedundant:
{
Description: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. ,
Required: False ,
}
boolean ,
asyncScalingEnabled:
{
Description: If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling. ,
Required: False ,
}
boolean ,
planDefaultIdentity:
{
Description: Identity to use by platform for various features and integrations using managed identity. ,
Required: False ,
}
{
identityType:
{
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Required: False ,
}
string ,
}
,
isCustomMode:
{
Description: Whether this server farm is in custom mode. ,
Required: False ,
}
boolean ,
registryAdapters:
{
Description: Registry adapters associated with this App Service plan. ,
Required: False ,
}
[
{
registryKey:
{
Description: Registry key for the adapter. ,
Required: False ,
}
string ,
type:
{
Description: Type of the registry adapter. ,
Enum:
{
Binary: No description available. ,
String: No description available. ,
Expand_String: No description available. ,
Multi_String: No description available. ,
DWord: No description available. ,
QWord: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultSecretReference:
{
Description: Key vault reference to the value that will be placed in the registry location ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installScripts:
{
Description: Install scripts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the install script. ,
Required: False ,
}
string ,
source:
{
Description: Source of the install script. ,
Required: False ,
}
{
sourceUri:
{
Description: Install script source URI where the install script file will be fetched from. ,
Required: False ,
}
string ,
type:
{
Description: Type of the install script. ,
Enum:
{
RemoteAzureBlob: No description available. ,
PlatformStorage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
network:
{
Description: All network settings for the server farm. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
}
,
storageMounts:
{
Description: Storage mounts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage mount. ,
Required: False ,
}
string ,
type:
{
Description: Type of the storage mount. ,
Enum:
{
AzureFiles: No description available. ,
LocalStorage: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the fileshare/storage. ,
Required: False ,
}
string ,
destinationPath:
{
Description: Path on worker where storage will be mounted. ,
Required: False ,
}
string ,
credentialsKeyVaultReference:
{
Description: KV reference to the credentials to connect to the share. ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
rdpEnabled:
{
Description: If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled. ,
Required: False ,
}
boolean ,
}
,
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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}
,
]
,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_ListByResourceGroup (new)
Description :  Description for 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 ,
}
{
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 ,
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 ,
numberOfWorkers:
{
Description: The number of instances that are 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 ,
elasticScaleEnabled:
{
Description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku ,
Required: False ,
}
boolean ,
maximumElasticWorkerCount:
{
Description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
freeOfferExpirationTime:
{
Description: The time when the server farm free offer expires. ,
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 ,
isXenon:
{
Description: Obsolete: If Hyper-V container app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: If Hyper-V container 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 Plan. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
kubeEnvironmentProfile:
{
Description: Specification for the Kubernetes Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Kubernetes Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Kubernetes Environment. ,
Required: False ,
}
string ,
}
,
zoneRedundant:
{
Description: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. ,
Required: False ,
}
boolean ,
asyncScalingEnabled:
{
Description: If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling. ,
Required: False ,
}
boolean ,
planDefaultIdentity:
{
Description: Identity to use by platform for various features and integrations using managed identity. ,
Required: False ,
}
{
identityType:
{
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Required: False ,
}
string ,
}
,
isCustomMode:
{
Description: Whether this server farm is in custom mode. ,
Required: False ,
}
boolean ,
registryAdapters:
{
Description: Registry adapters associated with this App Service plan. ,
Required: False ,
}
[
{
registryKey:
{
Description: Registry key for the adapter. ,
Required: False ,
}
string ,
type:
{
Description: Type of the registry adapter. ,
Enum:
{
Binary: No description available. ,
String: No description available. ,
Expand_String: No description available. ,
Multi_String: No description available. ,
DWord: No description available. ,
QWord: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultSecretReference:
{
Description: Key vault reference to the value that will be placed in the registry location ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installScripts:
{
Description: Install scripts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the install script. ,
Required: False ,
}
string ,
source:
{
Description: Source of the install script. ,
Required: False ,
}
{
sourceUri:
{
Description: Install script source URI where the install script file will be fetched from. ,
Required: False ,
}
string ,
type:
{
Description: Type of the install script. ,
Enum:
{
RemoteAzureBlob: No description available. ,
PlatformStorage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
network:
{
Description: All network settings for the server farm. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
}
,
storageMounts:
{
Description: Storage mounts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage mount. ,
Required: False ,
}
string ,
type:
{
Description: Type of the storage mount. ,
Enum:
{
AzureFiles: No description available. ,
LocalStorage: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the fileshare/storage. ,
Required: False ,
}
string ,
destinationPath:
{
Description: Path on worker where storage will be mounted. ,
Required: False ,
}
string ,
credentialsKeyVaultReference:
{
Description: KV reference to the credentials to connect to the share. ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
rdpEnabled:
{
Description: If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled. ,
Required: False ,
}
boolean ,
}
,
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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}
,
]
,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_Get (new)
Description :  Description for 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 ,
}
{
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 ,
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 ,
numberOfWorkers:
{
Description: The number of instances that are 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 ,
elasticScaleEnabled:
{
Description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku ,
Required: False ,
}
boolean ,
maximumElasticWorkerCount:
{
Description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
freeOfferExpirationTime:
{
Description: The time when the server farm free offer expires. ,
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 ,
isXenon:
{
Description: Obsolete: If Hyper-V container app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: If Hyper-V container 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 Plan. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
kubeEnvironmentProfile:
{
Description: Specification for the Kubernetes Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Kubernetes Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Kubernetes Environment. ,
Required: False ,
}
string ,
}
,
zoneRedundant:
{
Description: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. ,
Required: False ,
}
boolean ,
asyncScalingEnabled:
{
Description: If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling. ,
Required: False ,
}
boolean ,
planDefaultIdentity:
{
Description: Identity to use by platform for various features and integrations using managed identity. ,
Required: False ,
}
{
identityType:
{
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Required: False ,
}
string ,
}
,
isCustomMode:
{
Description: Whether this server farm is in custom mode. ,
Required: False ,
}
boolean ,
registryAdapters:
{
Description: Registry adapters associated with this App Service plan. ,
Required: False ,
}
[
{
registryKey:
{
Description: Registry key for the adapter. ,
Required: False ,
}
string ,
type:
{
Description: Type of the registry adapter. ,
Enum:
{
Binary: No description available. ,
String: No description available. ,
Expand_String: No description available. ,
Multi_String: No description available. ,
DWord: No description available. ,
QWord: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultSecretReference:
{
Description: Key vault reference to the value that will be placed in the registry location ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installScripts:
{
Description: Install scripts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the install script. ,
Required: False ,
}
string ,
source:
{
Description: Source of the install script. ,
Required: False ,
}
{
sourceUri:
{
Description: Install script source URI where the install script file will be fetched from. ,
Required: False ,
}
string ,
type:
{
Description: Type of the install script. ,
Enum:
{
RemoteAzureBlob: No description available. ,
PlatformStorage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
network:
{
Description: All network settings for the server farm. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
}
,
storageMounts:
{
Description: Storage mounts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage mount. ,
Required: False ,
}
string ,
type:
{
Description: Type of the storage mount. ,
Enum:
{
AzureFiles: No description available. ,
LocalStorage: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the fileshare/storage. ,
Required: False ,
}
string ,
destinationPath:
{
Description: Path on worker where storage will be mounted. ,
Required: False ,
}
string ,
credentialsKeyVaultReference:
{
Description: KV reference to the credentials to connect to the share. ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
rdpEnabled:
{
Description: If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled. ,
Required: False ,
}
boolean ,
}
,
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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}
,
]
,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_CreateOrUpdate (new)
Description :  Description for 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 ,
}
{
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 ,
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 ,
numberOfWorkers:
{
Description: The number of instances that are 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 ,
elasticScaleEnabled:
{
Description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku ,
Required: False ,
}
boolean ,
maximumElasticWorkerCount:
{
Description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
freeOfferExpirationTime:
{
Description: The time when the server farm free offer expires. ,
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 ,
isXenon:
{
Description: Obsolete: If Hyper-V container app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: If Hyper-V container 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 Plan. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
kubeEnvironmentProfile:
{
Description: Specification for the Kubernetes Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Kubernetes Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Kubernetes Environment. ,
Required: False ,
}
string ,
}
,
zoneRedundant:
{
Description: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. ,
Required: False ,
}
boolean ,
asyncScalingEnabled:
{
Description: If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling. ,
Required: False ,
}
boolean ,
planDefaultIdentity:
{
Description: Identity to use by platform for various features and integrations using managed identity. ,
Required: False ,
}
{
identityType:
{
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Required: False ,
}
string ,
}
,
isCustomMode:
{
Description: Whether this server farm is in custom mode. ,
Required: False ,
}
boolean ,
registryAdapters:
{
Description: Registry adapters associated with this App Service plan. ,
Required: False ,
}
[
{
registryKey:
{
Description: Registry key for the adapter. ,
Required: False ,
}
string ,
type:
{
Description: Type of the registry adapter. ,
Enum:
{
Binary: No description available. ,
String: No description available. ,
Expand_String: No description available. ,
Multi_String: No description available. ,
DWord: No description available. ,
QWord: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultSecretReference:
{
Description: Key vault reference to the value that will be placed in the registry location ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installScripts:
{
Description: Install scripts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the install script. ,
Required: False ,
}
string ,
source:
{
Description: Source of the install script. ,
Required: False ,
}
{
sourceUri:
{
Description: Install script source URI where the install script file will be fetched from. ,
Required: False ,
}
string ,
type:
{
Description: Type of the install script. ,
Enum:
{
RemoteAzureBlob: No description available. ,
PlatformStorage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
network:
{
Description: All network settings for the server farm. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
}
,
storageMounts:
{
Description: Storage mounts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage mount. ,
Required: False ,
}
string ,
type:
{
Description: Type of the storage mount. ,
Enum:
{
AzureFiles: No description available. ,
LocalStorage: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the fileshare/storage. ,
Required: False ,
}
string ,
destinationPath:
{
Description: Path on worker where storage will be mounted. ,
Required: False ,
}
string ,
credentialsKeyVaultReference:
{
Description: KV reference to the credentials to connect to the share. ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
rdpEnabled:
{
Description: If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled. ,
Required: False ,
}
boolean ,
}
,
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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}
,
]
,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
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 ,
}
{
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 ,
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 ,
numberOfWorkers:
{
Description: The number of instances that are 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 ,
elasticScaleEnabled:
{
Description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku ,
Required: False ,
}
boolean ,
maximumElasticWorkerCount:
{
Description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
freeOfferExpirationTime:
{
Description: The time when the server farm free offer expires. ,
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 ,
isXenon:
{
Description: Obsolete: If Hyper-V container app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: If Hyper-V container 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 Plan. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
kubeEnvironmentProfile:
{
Description: Specification for the Kubernetes Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Kubernetes Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Kubernetes Environment. ,
Required: False ,
}
string ,
}
,
zoneRedundant:
{
Description: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. ,
Required: False ,
}
boolean ,
asyncScalingEnabled:
{
Description: If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling. ,
Required: False ,
}
boolean ,
planDefaultIdentity:
{
Description: Identity to use by platform for various features and integrations using managed identity. ,
Required: False ,
}
{
identityType:
{
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Required: False ,
}
string ,
}
,
isCustomMode:
{
Description: Whether this server farm is in custom mode. ,
Required: False ,
}
boolean ,
registryAdapters:
{
Description: Registry adapters associated with this App Service plan. ,
Required: False ,
}
[
{
registryKey:
{
Description: Registry key for the adapter. ,
Required: False ,
}
string ,
type:
{
Description: Type of the registry adapter. ,
Enum:
{
Binary: No description available. ,
String: No description available. ,
Expand_String: No description available. ,
Multi_String: No description available. ,
DWord: No description available. ,
QWord: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultSecretReference:
{
Description: Key vault reference to the value that will be placed in the registry location ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installScripts:
{
Description: Install scripts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the install script. ,
Required: False ,
}
string ,
source:
{
Description: Source of the install script. ,
Required: False ,
}
{
sourceUri:
{
Description: Install script source URI where the install script file will be fetched from. ,
Required: False ,
}
string ,
type:
{
Description: Type of the install script. ,
Enum:
{
RemoteAzureBlob: No description available. ,
PlatformStorage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
network:
{
Description: All network settings for the server farm. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
}
,
storageMounts:
{
Description: Storage mounts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage mount. ,
Required: False ,
}
string ,
type:
{
Description: Type of the storage mount. ,
Enum:
{
AzureFiles: No description available. ,
LocalStorage: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the fileshare/storage. ,
Required: False ,
}
string ,
destinationPath:
{
Description: Path on worker where storage will be mounted. ,
Required: False ,
}
string ,
credentialsKeyVaultReference:
{
Description: KV reference to the credentials to connect to the share. ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
rdpEnabled:
{
Description: If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled. ,
Required: False ,
}
boolean ,
}
,
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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}
,
]
,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
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 ,
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 ,
numberOfWorkers:
{
Description: The number of instances that are 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 ,
elasticScaleEnabled:
{
Description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku ,
Required: False ,
}
boolean ,
maximumElasticWorkerCount:
{
Description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
freeOfferExpirationTime:
{
Description: The time when the server farm free offer expires. ,
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 ,
isXenon:
{
Description: Obsolete: If Hyper-V container app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: If Hyper-V container 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 Plan. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
kubeEnvironmentProfile:
{
Description: Specification for the Kubernetes Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Kubernetes Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Kubernetes Environment. ,
Required: False ,
}
string ,
}
,
zoneRedundant:
{
Description: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. ,
Required: False ,
}
boolean ,
asyncScalingEnabled:
{
Description: If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling. ,
Required: False ,
}
boolean ,
planDefaultIdentity:
{
Description: Identity to use by platform for various features and integrations using managed identity. ,
Required: False ,
}
{
identityType:
{
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Required: False ,
}
string ,
}
,
isCustomMode:
{
Description: Whether this server farm is in custom mode. ,
Required: False ,
}
boolean ,
registryAdapters:
{
Description: Registry adapters associated with this App Service plan. ,
Required: False ,
}
[
{
registryKey:
{
Description: Registry key for the adapter. ,
Required: False ,
}
string ,
type:
{
Description: Type of the registry adapter. ,
Enum:
{
Binary: No description available. ,
String: No description available. ,
Expand_String: No description available. ,
Multi_String: No description available. ,
DWord: No description available. ,
QWord: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultSecretReference:
{
Description: Key vault reference to the value that will be placed in the registry location ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installScripts:
{
Description: Install scripts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the install script. ,
Required: False ,
}
string ,
source:
{
Description: Source of the install script. ,
Required: False ,
}
{
sourceUri:
{
Description: Install script source URI where the install script file will be fetched from. ,
Required: False ,
}
string ,
type:
{
Description: Type of the install script. ,
Enum:
{
RemoteAzureBlob: No description available. ,
PlatformStorage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
network:
{
Description: All network settings for the server farm. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
}
,
storageMounts:
{
Description: Storage mounts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage mount. ,
Required: False ,
}
string ,
type:
{
Description: Type of the storage mount. ,
Enum:
{
AzureFiles: No description available. ,
LocalStorage: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the fileshare/storage. ,
Required: False ,
}
string ,
destinationPath:
{
Description: Path on worker where storage will be mounted. ,
Required: False ,
}
string ,
credentialsKeyVaultReference:
{
Description: KV reference to the credentials to connect to the share. ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
rdpEnabled:
{
Description: If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled. ,
Required: False ,
}
boolean ,
}
,
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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}
,
]
,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_Delete (new)
Description :  Description for 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)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_Update (new)
Description :  Description for 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 ,
}
{
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 ,
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 ,
numberOfWorkers:
{
Description: The number of instances that are 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 ,
elasticScaleEnabled:
{
Description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku ,
Required: False ,
}
boolean ,
maximumElasticWorkerCount:
{
Description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
freeOfferExpirationTime:
{
Description: The time when the server farm free offer expires. ,
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 ,
isXenon:
{
Description: Obsolete: If Hyper-V container app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: If Hyper-V container 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 Plan. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
kubeEnvironmentProfile:
{
Description: Specification for the Kubernetes Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Kubernetes Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Kubernetes Environment. ,
Required: False ,
}
string ,
}
,
zoneRedundant:
{
Description: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
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 ,
}
{
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 ,
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 ,
numberOfWorkers:
{
Description: The number of instances that are 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 ,
elasticScaleEnabled:
{
Description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku ,
Required: False ,
}
boolean ,
maximumElasticWorkerCount:
{
Description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
freeOfferExpirationTime:
{
Description: The time when the server farm free offer expires. ,
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 ,
isXenon:
{
Description: Obsolete: If Hyper-V container app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: If Hyper-V container 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 Plan. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
kubeEnvironmentProfile:
{
Description: Specification for the Kubernetes Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Kubernetes Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Kubernetes Environment. ,
Required: False ,
}
string ,
}
,
zoneRedundant:
{
Description: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. ,
Required: False ,
}
boolean ,
asyncScalingEnabled:
{
Description: If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling. ,
Required: False ,
}
boolean ,
planDefaultIdentity:
{
Description: Identity to use by platform for various features and integrations using managed identity. ,
Required: False ,
}
{
identityType:
{
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Required: False ,
}
string ,
}
,
isCustomMode:
{
Description: Whether this server farm is in custom mode. ,
Required: False ,
}
boolean ,
registryAdapters:
{
Description: Registry adapters associated with this App Service plan. ,
Required: False ,
}
[
{
registryKey:
{
Description: Registry key for the adapter. ,
Required: False ,
}
string ,
type:
{
Description: Type of the registry adapter. ,
Enum:
{
Binary: No description available. ,
String: No description available. ,
Expand_String: No description available. ,
Multi_String: No description available. ,
DWord: No description available. ,
QWord: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultSecretReference:
{
Description: Key vault reference to the value that will be placed in the registry location ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installScripts:
{
Description: Install scripts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the install script. ,
Required: False ,
}
string ,
source:
{
Description: Source of the install script. ,
Required: False ,
}
{
sourceUri:
{
Description: Install script source URI where the install script file will be fetched from. ,
Required: False ,
}
string ,
type:
{
Description: Type of the install script. ,
Enum:
{
RemoteAzureBlob: No description available. ,
PlatformStorage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
network:
{
Description: All network settings for the server farm. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
}
,
storageMounts:
{
Description: Storage mounts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage mount. ,
Required: False ,
}
string ,
type:
{
Description: Type of the storage mount. ,
Enum:
{
AzureFiles: No description available. ,
LocalStorage: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the fileshare/storage. ,
Required: False ,
}
string ,
destinationPath:
{
Description: Path on worker where storage will be mounted. ,
Required: False ,
}
string ,
credentialsKeyVaultReference:
{
Description: KV reference to the credentials to connect to the share. ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
rdpEnabled:
{
Description: If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled. ,
Required: False ,
}
boolean ,
}
,
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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}
,
]
,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: AppServicePlan resource specific properties ,
Required: False ,
}
{
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 ,
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 ,
numberOfWorkers:
{
Description: The number of instances that are 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 ,
elasticScaleEnabled:
{
Description: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku ,
Required: False ,
}
boolean ,
maximumElasticWorkerCount:
{
Description: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
freeOfferExpirationTime:
{
Description: The time when the server farm free offer expires. ,
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 ,
isXenon:
{
Description: Obsolete: If Hyper-V container app service plan true, false otherwise. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: If Hyper-V container 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 Plan. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
kubeEnvironmentProfile:
{
Description: Specification for the Kubernetes Environment to use for the App Service plan. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Kubernetes Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the Kubernetes Environment. ,
Required: False ,
}
string ,
}
,
zoneRedundant:
{
Description: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. ,
Required: False ,
}
boolean ,
asyncScalingEnabled:
{
Description: If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling. ,
Required: False ,
}
boolean ,
planDefaultIdentity:
{
Description: Identity to use by platform for various features and integrations using managed identity. ,
Required: False ,
}
{
identityType:
{
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Required: False ,
}
string ,
}
,
isCustomMode:
{
Description: Whether this server farm is in custom mode. ,
Required: False ,
}
boolean ,
registryAdapters:
{
Description: Registry adapters associated with this App Service plan. ,
Required: False ,
}
[
{
registryKey:
{
Description: Registry key for the adapter. ,
Required: False ,
}
string ,
type:
{
Description: Type of the registry adapter. ,
Enum:
{
Binary: No description available. ,
String: No description available. ,
Expand_String: No description available. ,
Multi_String: No description available. ,
DWord: No description available. ,
QWord: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultSecretReference:
{
Description: Key vault reference to the value that will be placed in the registry location ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installScripts:
{
Description: Install scripts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the install script. ,
Required: False ,
}
string ,
source:
{
Description: Source of the install script. ,
Required: False ,
}
{
sourceUri:
{
Description: Install script source URI where the install script file will be fetched from. ,
Required: False ,
}
string ,
type:
{
Description: Type of the install script. ,
Enum:
{
RemoteAzureBlob: No description available. ,
PlatformStorage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
network:
{
Description: All network settings for the server farm. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} ,
Required: False ,
}
string ,
}
,
storageMounts:
{
Description: Storage mounts associated with this App Service plan. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage mount. ,
Required: False ,
}
string ,
type:
{
Description: Type of the storage mount. ,
Enum:
{
AzureFiles: No description available. ,
LocalStorage: No description available. ,
FileShare: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the fileshare/storage. ,
Required: False ,
}
string ,
destinationPath:
{
Description: Path on worker where storage will be mounted. ,
Required: False ,
}
string ,
credentialsKeyVaultReference:
{
Description: KV reference to the credentials to connect to the share. ,
Required: False ,
}
{
secretUri:
{
Description: Key vault secret URI. ,
Required: False ,
}
string ,
referenceStatus:
{
Description: Reference status of the key vault secret. ,
Required: False ,
}
string ,
}
,
}
,
]
,
rdpEnabled:
{
Description: If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled. ,
Required: False ,
}
boolean ,
}
,
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 ,
elasticMaximum:
{
Description: Maximum number of Elastic 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 ,
}
,
]
,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: 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 ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_ListCapabilities (new)
Description :  Description for 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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_GetServerFarmRdpPassword (new)
Description :  Description for Get the RDP password for an IsCustomMode ServerFarm.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/getrdppassword
{
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)

{
rdpPassword:
{
Description: The RDP password for the server farm. ,
Required: False ,
}
string ,
rdpPasswordExpiry:
{
Description: The RDP password expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_GetHybridConnection (new)
Description :  Description for 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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_DeleteHybridConnection (new)
Description :  Description for 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)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_ListHybridConnectionKeys (new)
Description :  Description for 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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_ListWebAppsByHybridConnection (new)
Description :  Description for 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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_GetHybridConnectionPlanLimit (new)
Description :  Description for 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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_ListHybridConnections (new)
Description :  Description for 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 ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_GetServerFarmInstanceDetails (new)
Description :  Description for Get the instance details for an app service plan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/listinstances
{
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: ServerFarmInstanceDetails resource specific properties ,
Required: False ,
}
{
serverFarmName:
{
Description: The server farm name. ,
Required: False ,
}
string ,
instances:
{
Description: The list of server farm instances. ,
Required: False ,
}
[
{
instanceName:
{
Description: The instance name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The instance IP address. ,
Required: False ,
}
string ,
status:
{
Description: The instance status. ,
Required: False ,
}
string ,
}
,
]
,
instanceCount:
{
Description: The total number of instances. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_RestartWebApps (new)
Description :  Description for 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)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServicePlans_ListWebApps (new)
Description :  Description for 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 ,
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 ,
$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 ,
}

⚐ 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 ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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 ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon 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 ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
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. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
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. ,
VSTSRM: 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. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: 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 \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
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: <