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: 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 ,
}
,
}
AppServicePlans_GetServerFarmSkus (new)
Description :  Description for Gets all selectable SKUs for a given App Service Plan
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
$schema: object ,
}

⚐ 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_ListUsages (new)
Description :  Description for Gets server farm usage information
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
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'). ,
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 ,
}
,
}
AppServicePlans_ListVnets (new)
Description :  Description for Get all Virtual Networks associated with an App Service plan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ 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_GetVnetFromServerFarm (new)
Description :  Description for Get a Virtual Network associated with an App Service plan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ 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_GetVnetGateway (new)
Description :  Description for Get a Virtual Network gateway.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}

⚐ 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_UpdateVnetGateway (new)
Description :  Description for Update a Virtual Network gateway.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}

⚐ 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_ListRoutesForVnet (new)
Description :  Description for Get all routes that are associated with a Virtual Network in an App Service plan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (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_GetRouteForVnet (new)
Description :  Description for Get a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (404)

{}

⚐ 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_CreateOrUpdateVnetRoute (new)
Description :  Description for Create or update a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ 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_DeleteVnetRoute (new)
Description :  Description for Delete a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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_UpdateVnetRoute (new)
Description :  Description for Create or update a Virtual Network route in an App Service plan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ 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_RebootWorker (new)
Description :  Description for Reboot a worker machine in an App Service plan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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_RecycleManagedInstanceWorker (new)
Description :  Description for Recycles a managed instance worker machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/recycleinstance
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the App Service plan. ,
Required: True ,
}
string ,
workerName:
{
Description: Name of worker machine. ,
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 ,
}
,
}
Certificates_List (new)
Description :  Description for Get all certificates for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates
{
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 information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
Certificates_ListByResourceGroup (new)
Description :  Description for Get all certificates in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates
{
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: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
Certificates_Get (new)
Description :  Description for Get a certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
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: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
Certificates_CreateOrUpdate (new)
Description :  Description for Create or update a certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate, if it exists already. ,
Required: True ,
}
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
Certificates_Delete (new)
Description :  Description for Delete a certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
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 ,
}
,
}
Certificates_Update (new)
Description :  Description for Create or update a certificate.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate, if it exists already. ,
Required: True ,
}
{
properties:
{
Description: CertificatePatchResource resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: 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 ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
DeletedWebApps_List (new)
Description :  Description for Get all deleted apps for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites
{
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: DeletedSite resource specific properties ,
Required: False ,
}
{
deletedSiteId:
{
Description: Numeric id for the deleted site ,
Format: int32 ,
Required: False ,
}
integer ,
deletedTimestamp:
{
Description: Time in UTC when the app was deleted. ,
Required: False ,
}
string ,
subscription:
{
Description: Subscription containing the deleted site ,
Required: False ,
}
string ,
resourceGroup:
{
Description: ResourceGroup that contained the deleted site ,
Required: False ,
}
string ,
deletedSiteName:
{
Description: Name of the deleted site ,
Required: False ,
}
string ,
slot:
{
Description: Slot of the deleted site ,
Required: False ,
}
string ,
kind:
{
Description: Kind of site that was deleted ,
Required: False ,
}
string ,
geoRegionName:
{
Description: Geo Region of the deleted site ,
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 ,
}
,
}
DeletedWebApps_ListByLocation (new)
Description :  Description for Get all deleted apps for a subscription at location
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites
{
location:
{
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: DeletedSite resource specific properties ,
Required: False ,
}
{
deletedSiteId:
{
Description: Numeric id for the deleted site ,
Format: int32 ,
Required: False ,
}
integer ,
deletedTimestamp:
{
Description: Time in UTC when the app was deleted. ,
Required: False ,
}
string ,
subscription:
{
Description: Subscription containing the deleted site ,
Required: False ,
}
string ,
resourceGroup:
{
Description: ResourceGroup that contained the deleted site ,
Required: False ,
}
string ,
deletedSiteName:
{
Description: Name of the deleted site ,
Required: False ,
}
string ,
slot:
{
Description: Slot of the deleted site ,
Required: False ,
}
string ,
kind:
{
Description: Kind of site that was deleted ,
Required: False ,
}
string ,
geoRegionName:
{
Description: Geo Region of the deleted site ,
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 ,
}
,
}
DeletedWebApps_GetDeletedWebAppByLocation (new)
Description :  Description for Get deleted app for a subscription at location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites/{deletedSiteId}
{
location:
{
Required: True ,
}
string ,
deletedSiteId:
{
Description: The numeric ID of the deleted app, e.g. 12345 ,
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: DeletedSite resource specific properties ,
Required: False ,
}
{
deletedSiteId:
{
Description: Numeric id for the deleted site ,
Format: int32 ,
Required: False ,
}
integer ,
deletedTimestamp:
{
Description: Time in UTC when the app was deleted. ,
Required: False ,
}
string ,
subscription:
{
Description: Subscription containing the deleted site ,
Required: False ,
}
string ,
resourceGroup:
{
Description: ResourceGroup that contained the deleted site ,
Required: False ,
}
string ,
deletedSiteName:
{
Description: Name of the deleted site ,
Required: False ,
}
string ,
slot:
{
Description: Slot of the deleted site ,
Required: False ,
}
string ,
kind:
{
Description: Kind of site that was deleted ,
Required: False ,
}
string ,
geoRegionName:
{
Description: Geo Region of the deleted site ,
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 ,
}
,
}
Diagnostics_ListHostingEnvironmentDetectorResponses (new)
Description :  Description for List Hosting Environment Detector Responses
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site Name ,
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: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
id:
{
Description: Id of detector ,
Required: False ,
}
string ,
name:
{
Description: Name of detector ,
Required: False ,
}
string ,
description:
{
Description: Short description of the detector and its purpose. ,
Required: False ,
}
string ,
author:
{
Description: Author of the detector. ,
Required: False ,
}
string ,
category:
{
Description: Problem category. This serves for organizing group for detectors. ,
Required: False ,
}
string ,
supportTopicList:
{
Description: List of Support Topics for which this detector is enabled. ,
Required: False ,
}
[
{
id:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
pesId:
{
Description: Unique resource Id ,
Required: False ,
}
string ,
}
,
]
,
analysisType:
{
Description: Analysis Types for which this detector should apply to. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Whether this detector is an Analysis Detector or not. ,
Enum:
{
Detector: No description available. ,
Analysis: No description available. ,
CategoryOverview: No description available. ,
}
,
Required: False ,
}
enum ,
score:
{
Description: Defines score of a detector to power ML based matching. ,
Format: float ,
Required: False ,
}
number ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
type:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
PieChart: No description available. ,
DataSummary: No description available. ,
Email: No description available. ,
Insights: No description available. ,
DynamicInsight: No description available. ,
Markdown: No description available. ,
Detector: No description available. ,
DropDown: No description available. ,
Card: No description available. ,
Solution: No description available. ,
Guage: No description available. ,
Form: No description available. ,
ChangeSets: No description available. ,
ChangeAnalysisOnboarding: No description available. ,
ChangesView: No description available. ,
AppInsight: No description available. ,
DependencyGraph: No description available. ,
DownTime: No description available. ,
SummaryCard: No description available. ,
SearchComponent: No description available. ,
AppInsightEnablement: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
status:
{
Description: Indicates status of the most severe insight. ,
Required: False ,
}
{
message:
{
Description: Descriptive message. ,
Required: False ,
}
string ,
statusId:
{
Description: Level of the most severe insight generated by the detector. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Info: No description available. ,
Success: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataProvidersMetadata:
{
Description: Additional configuration for different data providers to be used by the UI ,
Required: False ,
}
[
{
providerName:
{
Required: False ,
}
string ,
propertyBag:
{
Description: Settings for the data provider ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
suggestedUtterances:
{
Description: Suggested utterances where the detector can be applicable. ,
Required: False ,
}
{
query:
{
Description: Search Query. ,
Required: False ,
}
string ,
results:
{
Description: Array of utterance results for search query. ,
Required: False ,
}
[
{
sampleUtterance:
{
Description: A sample utterance. ,
Required: False ,
}
{
text:
{
Description: Text attribute of sample utterance. ,
Required: False ,
}
string ,
links:
{
Description: Links attribute of sample utterance. ,
Required: False ,
}
[
string ,
]
,
qid:
{
Description: Question id of sample utterance (for stackoverflow questions titles). ,
Required: False ,
}
string ,
}
,
score:
{
Description: Score of a sample utterance. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
]
,
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 ,
}
,
}
Diagnostics_GetHostingEnvironmentDetectorResponse (new)
Description :  Description for Get Hosting Environment Detector Response
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: App Service Environment Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
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: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
id:
{
Description: Id of detector ,
Required: False ,
}
string ,
name:
{
Description: Name of detector ,
Required: False ,
}
string ,
description:
{
Description: Short description of the detector and its purpose. ,
Required: False ,
}
string ,
author:
{
Description: Author of the detector. ,
Required: False ,
}
string ,
category:
{
Description: Problem category. This serves for organizing group for detectors. ,
Required: False ,
}
string ,
supportTopicList:
{
Description: List of Support Topics for which this detector is enabled. ,
Required: False ,
}
[
{
id:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
pesId:
{
Description: Unique resource Id ,
Required: False ,
}
string ,
}
,
]
,
analysisType:
{
Description: Analysis Types for which this detector should apply to. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Whether this detector is an Analysis Detector or not. ,
Enum:
{
Detector: No description available. ,
Analysis: No description available. ,
CategoryOverview: No description available. ,
}
,
Required: False ,
}
enum ,
score:
{
Description: Defines score of a detector to power ML based matching. ,
Format: float ,
Required: False ,
}
number ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
type:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
PieChart: No description available. ,
DataSummary: No description available. ,
Email: No description available. ,
Insights: No description available. ,
DynamicInsight: No description available. ,
Markdown: No description available. ,
Detector: No description available. ,
DropDown: No description available. ,
Card: No description available. ,
Solution: No description available. ,
Guage: No description available. ,
Form: No description available. ,
ChangeSets: No description available. ,
ChangeAnalysisOnboarding: No description available. ,
ChangesView: No description available. ,
AppInsight: No description available. ,
DependencyGraph: No description available. ,
DownTime: No description available. ,
SummaryCard: No description available. ,
SearchComponent: No description available. ,
AppInsightEnablement: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
status:
{
Description: Indicates status of the most severe insight. ,
Required: False ,
}
{
message:
{
Description: Descriptive message. ,
Required: False ,
}
string ,
statusId:
{
Description: Level of the most severe insight generated by the detector. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Info: No description available. ,
Success: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataProvidersMetadata:
{
Description: Additional configuration for different data providers to be used by the UI ,
Required: False ,
}
[
{
providerName:
{
Required: False ,
}
string ,
propertyBag:
{
Description: Settings for the data provider ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
suggestedUtterances:
{
Description: Suggested utterances where the detector can be applicable. ,
Required: False ,
}
{
query:
{
Description: Search Query. ,
Required: False ,
}
string ,
results:
{
Description: Array of utterance results for search query. ,
Required: False ,
}
[
{
sampleUtterance:
{
Description: A sample utterance. ,
Required: False ,
}
{
text:
{
Description: Text attribute of sample utterance. ,
Required: False ,
}
string ,
links:
{
Description: Links attribute of sample utterance. ,
Required: False ,
}
[
string ,
]
,
qid:
{
Description: Question id of sample utterance (for stackoverflow questions titles). ,
Required: False ,
}
string ,
}
,
score:
{
Description: Score of a sample utterance. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
}
,
}
Diagnostics_ListSiteDetectorResponses (new)
Description :  Description for List Site Detector Responses
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
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: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
id:
{
Description: Id of detector ,
Required: False ,
}
string ,
name:
{
Description: Name of detector ,
Required: False ,
}
string ,
description:
{
Description: Short description of the detector and its purpose. ,
Required: False ,
}
string ,
author:
{
Description: Author of the detector. ,
Required: False ,
}
string ,
category:
{
Description: Problem category. This serves for organizing group for detectors. ,
Required: False ,
}
string ,
supportTopicList:
{
Description: List of Support Topics for which this detector is enabled. ,
Required: False ,
}
[
{
id:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
pesId:
{
Description: Unique resource Id ,
Required: False ,
}
string ,
}
,
]
,
analysisType:
{
Description: Analysis Types for which this detector should apply to. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Whether this detector is an Analysis Detector or not. ,
Enum:
{
Detector: No description available. ,
Analysis: No description available. ,
CategoryOverview: No description available. ,
}
,
Required: False ,
}
enum ,
score:
{
Description: Defines score of a detector to power ML based matching. ,
Format: float ,
Required: False ,
}
number ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
type:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
PieChart: No description available. ,
DataSummary: No description available. ,
Email: No description available. ,
Insights: No description available. ,
DynamicInsight: No description available. ,
Markdown: No description available. ,
Detector: No description available. ,
DropDown: No description available. ,
Card: No description available. ,
Solution: No description available. ,
Guage: No description available. ,
Form: No description available. ,
ChangeSets: No description available. ,
ChangeAnalysisOnboarding: No description available. ,
ChangesView: No description available. ,
AppInsight: No description available. ,
DependencyGraph: No description available. ,
DownTime: No description available. ,
SummaryCard: No description available. ,
SearchComponent: No description available. ,
AppInsightEnablement: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
status:
{
Description: Indicates status of the most severe insight. ,
Required: False ,
}
{
message:
{
Description: Descriptive message. ,
Required: False ,
}
string ,
statusId:
{
Description: Level of the most severe insight generated by the detector. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Info: No description available. ,
Success: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataProvidersMetadata:
{
Description: Additional configuration for different data providers to be used by the UI ,
Required: False ,
}
[
{
providerName:
{
Required: False ,
}
string ,
propertyBag:
{
Description: Settings for the data provider ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
suggestedUtterances:
{
Description: Suggested utterances where the detector can be applicable. ,
Required: False ,
}
{
query:
{
Description: Search Query. ,
Required: False ,
}
string ,
results:
{
Description: Array of utterance results for search query. ,
Required: False ,
}
[
{
sampleUtterance:
{
Description: A sample utterance. ,
Required: False ,
}
{
text:
{
Description: Text attribute of sample utterance. ,
Required: False ,
}
string ,
links:
{
Description: Links attribute of sample utterance. ,
Required: False ,
}
[
string ,
]
,
qid:
{
Description: Question id of sample utterance (for stackoverflow questions titles). ,
Required: False ,
}
string ,
}
,
score:
{
Description: Score of a sample utterance. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
]
,
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 ,
}
,
}
Diagnostics_GetSiteDetectorResponse (new)
Description :  Description for Get site detector response
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
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: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
id:
{
Description: Id of detector ,
Required: False ,
}
string ,
name:
{
Description: Name of detector ,
Required: False ,
}
string ,
description:
{
Description: Short description of the detector and its purpose. ,
Required: False ,
}
string ,
author:
{
Description: Author of the detector. ,
Required: False ,
}
string ,
category:
{
Description: Problem category. This serves for organizing group for detectors. ,
Required: False ,
}
string ,
supportTopicList:
{
Description: List of Support Topics for which this detector is enabled. ,
Required: False ,
}
[
{
id:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
pesId:
{
Description: Unique resource Id ,
Required: False ,
}
string ,
}
,
]
,
analysisType:
{
Description: Analysis Types for which this detector should apply to. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Whether this detector is an Analysis Detector or not. ,
Enum:
{
Detector: No description available. ,
Analysis: No description available. ,
CategoryOverview: No description available. ,
}
,
Required: False ,
}
enum ,
score:
{
Description: Defines score of a detector to power ML based matching. ,
Format: float ,
Required: False ,
}
number ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
type:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
PieChart: No description available. ,
DataSummary: No description available. ,
Email: No description available. ,
Insights: No description available. ,
DynamicInsight: No description available. ,
Markdown: No description available. ,
Detector: No description available. ,
DropDown: No description available. ,
Card: No description available. ,
Solution: No description available. ,
Guage: No description available. ,
Form: No description available. ,
ChangeSets: No description available. ,
ChangeAnalysisOnboarding: No description available. ,
ChangesView: No description available. ,
AppInsight: No description available. ,
DependencyGraph: No description available. ,
DownTime: No description available. ,
SummaryCard: No description available. ,
SearchComponent: No description available. ,
AppInsightEnablement: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
status:
{
Description: Indicates status of the most severe insight. ,
Required: False ,
}
{
message:
{
Description: Descriptive message. ,
Required: False ,
}
string ,
statusId:
{
Description: Level of the most severe insight generated by the detector. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Info: No description available. ,
Success: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataProvidersMetadata:
{
Description: Additional configuration for different data providers to be used by the UI ,
Required: False ,
}
[
{
providerName:
{
Required: False ,
}
string ,
propertyBag:
{
Description: Settings for the data provider ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
suggestedUtterances:
{
Description: Suggested utterances where the detector can be applicable. ,
Required: False ,
}
{
query:
{
Description: Search Query. ,
Required: False ,
}
string ,
results:
{
Description: Array of utterance results for search query. ,
Required: False ,
}
[
{
sampleUtterance:
{
Description: A sample utterance. ,
Required: False ,
}
{
text:
{
Description: Text attribute of sample utterance. ,
Required: False ,
}
string ,
links:
{
Description: Links attribute of sample utterance. ,
Required: False ,
}
[
string ,
]
,
qid:
{
Description: Question id of sample utterance (for stackoverflow questions titles). ,
Required: False ,
}
string ,
}
,
score:
{
Description: Score of a sample utterance. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
}
,
}
Diagnostics_ListSiteDiagnosticCategories (new)
Description :  Description for Get Diagnostics Categories
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
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: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
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 ,
}
,
}
Diagnostics_GetSiteDiagnosticCategory (new)
Description :  Description for Get Diagnostics Category
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
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: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
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 ,
}
,
}
Diagnostics_ListSiteAnalyses (new)
Description :  Description for Get Site Analyses
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
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: AnalysisDefinition resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the Analysis ,
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 ,
}
,
}
Diagnostics_GetSiteAnalysis (new)
Description :  Description for Get Site Analysis
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
analysisName:
{
Description: Analysis Name ,
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: AnalysisDefinition resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the Analysis ,
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 ,
}
,
}
Diagnostics_ExecuteSiteAnalysis (new)
Description :  Description for Execute Analysis
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
analysisName:
{
Description: Analysis Resource Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
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: DiagnosticAnalysis resource specific properties ,
Required: False ,
}
{
startTime:
{
Description: Start time of the period ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the period ,
Format: date-time ,
Required: False ,
}
string ,
abnormalTimePeriods:
{
Description: List of time periods. ,
Required: False ,
}
[
{
startTime:
{
Description: Start time of the downtime ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the downtime ,
Format: date-time ,
Required: False ,
}
string ,
events:
{
Description: List of Possible Cause of downtime ,
Required: False ,
}
[
{
startTime:
{
Description: Start time of the correlated event ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the correlated event ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Message describing the event ,
Required: False ,
}
string ,
source:
{
Description: Represents the name of the Detector ,
Required: False ,
}
string ,
priority:
{
Description: Represents the rank of the Detector ,
Format: double ,
Required: False ,
}
number ,
metaData:
{
Description: Downtime metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Represents the type of the Detector ,
Enum:
{
ServiceIncident: No description available. ,
AppDeployment: No description available. ,
AppCrash: No description available. ,
RuntimeIssueDetected: No description available. ,
AseDeployment: No description available. ,
UserIssue: No description available. ,
PlatformIssue: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of proposed solutions ,
Required: False ,
}
[
{
id:
{
Description: Solution Id. ,
Format: double ,
Required: False ,
}
number ,
displayName:
{
Description: Display Name of the solution ,
Required: False ,
}
string ,
order:
{
Description: Order of the solution. ,
Format: double ,
Required: False ,
}
number ,
description:
{
Description: Description of the solution ,
Required: False ,
}
string ,
type:
{
Description: Type of Solution ,
Enum:
{
QuickSolution: No description available. ,
DeepInvestigation: No description available. ,
BestPractices: No description available. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: Solution Data. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Solution Metadata. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
solutions:
{
Description: List of proposed solutions ,
Required: False ,
}
[
{
id:
{
Description: Solution Id. ,
Format: double ,
Required: False ,
}
number ,
displayName:
{
Description: Display Name of the solution ,
Required: False ,
}
string ,
order:
{
Description: Order of the solution. ,
Format: double ,
Required: False ,
}
number ,
description:
{
Description: Description of the solution ,
Required: False ,
}
string ,
type:
{
Description: Type of Solution ,
Enum:
{
QuickSolution: No description available. ,
DeepInvestigation: No description available. ,
BestPractices: No description available. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: Solution Data. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Solution Metadata. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
payload:
{
Description: Data by each detector ,
Required: False ,
}
[
{
source:
{
Description: Name of the Detector ,
Required: False ,
}
string ,
detectorDefinition:
{
Description: Detector Definition ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
metrics:
{
Description: Source Metrics ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Metric's unit ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the period ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the period ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D ,
Required: False ,
}
string ,
values:
{
Description: Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain} ,
Required: False ,
}
[
{
timestamp:
{
Description: Time at which metric is measured ,
Format: date-time ,
Required: False ,
}
string ,
roleInstance:
{
Description: Role Instance. Null if this counter is not per instance This is returned and should be whichever instance name we desire to be returned i.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0) where RDWORKERNAME is Machine name below and RoleInstance name in parenthesis ,
Required: False ,
}
string ,
total:
{
Description: Total value of the metric. If multiple measurements are made this will have sum of all. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: Maximum of the metric sampled during the time period ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: Minimum of the metric sampled during the time period ,
Format: double ,
Required: False ,
}
number ,
isAggregated:
{
Description: Whether the values are aggregates across all workers or not ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
data:
{
Description: Additional Source Data ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
detectorMetaData:
{
Description: Detector Meta Data ,
Required: False ,
}
{
dataSource:
{
Description: Source of the Data ,
Required: False ,
}
{
instructions:
{
Description: Instructions if any for the data source ,
Required: False ,
}
[
string ,
]
,
dataSourceUri:
{
Description: Datasource Uri Links ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nonCorrelatedDetectors:
{
Description: Data by each detector for detectors that did not corelate ,
Required: False ,
}
[
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
}
Diagnostics_ListSiteDetectors (new)
Description :  Description for Get Detectors
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
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 ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
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 ,
}
,
}
Diagnostics_GetSiteDetector (new)
Description :  Description for Get Detector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Name ,
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 ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
Diagnostics_ExecuteSiteDetector (new)
Description :  Description for Execute Detector
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
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: DiagnosticDetectorResponse resource specific properties ,
Required: False ,
}
{
startTime:
{
Description: Start time of the period ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the period ,
Format: date-time ,
Required: False ,
}
string ,
issueDetected:
{
Description: Flag representing Issue was detected. ,
Required: False ,
}
boolean ,
detectorDefinition:
{
Description: Detector's definition ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
metrics:
{
Description: Metrics provided by the detector ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Metric's unit ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the period ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the period ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D ,
Required: False ,
}
string ,
values:
{
Description: Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain} ,
Required: False ,
}
[
{
timestamp:
{
Description: Time at which metric is measured ,
Format: date-time ,
Required: False ,
}
string ,
roleInstance:
{
Description: Role Instance. Null if this counter is not per instance This is returned and should be whichever instance name we desire to be returned i.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0) where RDWORKERNAME is Machine name below and RoleInstance name in parenthesis ,
Required: False ,
}
string ,
total:
{
Description: Total value of the metric. If multiple measurements are made this will have sum of all. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: Maximum of the metric sampled during the time period ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: Minimum of the metric sampled during the time period ,
Format: double ,
Required: False ,
}
number ,
isAggregated:
{
Description: Whether the values are aggregates across all workers or not ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
abnormalTimePeriods:
{
Description: List of Correlated events found by the detector ,
Required: False ,
}
[
{
startTime:
{
Description: Start time of the correlated event ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the correlated event ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Message describing the event ,
Required: False ,
}
string ,
source:
{
Description: Represents the name of the Detector ,
Required: False ,
}
string ,
priority:
{
Description: Represents the rank of the Detector ,
Format: double ,
Required: False ,
}
number ,
metaData:
{
Description: Downtime metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Represents the type of the Detector ,
Enum:
{
ServiceIncident: No description available. ,
AppDeployment: No description available. ,
AppCrash: No description available. ,
RuntimeIssueDetected: No description available. ,
AseDeployment: No description available. ,
UserIssue: No description available. ,
PlatformIssue: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of proposed solutions ,
Required: False ,
}
[
{
id:
{
Description: Solution Id. ,
Format: double ,
Required: False ,
}
number ,
displayName:
{
Description: Display Name of the solution ,
Required: False ,
}
string ,
order:
{
Description: Order of the solution. ,
Format: double ,
Required: False ,
}
number ,
description:
{
Description: Description of the solution ,
Required: False ,
}
string ,
type:
{
Description: Type of Solution ,
Enum:
{
QuickSolution: No description available. ,
DeepInvestigation: No description available. ,
BestPractices: No description available. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: Solution Data. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Solution Metadata. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
data:
{
Description: Additional Data that detector wants to send. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
responseMetaData:
{
Description: Meta Data ,
Required: False ,
}
{
dataSource:
{
Description: Source of the Data ,
Required: False ,
}
{
instructions:
{
Description: Instructions if any for the data source ,
Required: False ,
}
[
string ,
]
,
dataSourceUri:
{
Description: Datasource Uri Links ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
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 ,
}
,
}
Diagnostics_ListSiteDetectorResponsesSlot (new)
Description :  Description for List Site Detector Responses
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
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: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
id:
{
Description: Id of detector ,
Required: False ,
}
string ,
name:
{
Description: Name of detector ,
Required: False ,
}
string ,
description:
{
Description: Short description of the detector and its purpose. ,
Required: False ,
}
string ,
author:
{
Description: Author of the detector. ,
Required: False ,
}
string ,
category:
{
Description: Problem category. This serves for organizing group for detectors. ,
Required: False ,
}
string ,
supportTopicList:
{
Description: List of Support Topics for which this detector is enabled. ,
Required: False ,
}
[
{
id:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
pesId:
{
Description: Unique resource Id ,
Required: False ,
}
string ,
}
,
]
,
analysisType:
{
Description: Analysis Types for which this detector should apply to. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Whether this detector is an Analysis Detector or not. ,
Enum:
{
Detector: No description available. ,
Analysis: No description available. ,
CategoryOverview: No description available. ,
}
,
Required: False ,
}
enum ,
score:
{
Description: Defines score of a detector to power ML based matching. ,
Format: float ,
Required: False ,
}
number ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
type:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
PieChart: No description available. ,
DataSummary: No description available. ,
Email: No description available. ,
Insights: No description available. ,
DynamicInsight: No description available. ,
Markdown: No description available. ,
Detector: No description available. ,
DropDown: No description available. ,
Card: No description available. ,
Solution: No description available. ,
Guage: No description available. ,
Form: No description available. ,
ChangeSets: No description available. ,
ChangeAnalysisOnboarding: No description available. ,
ChangesView: No description available. ,
AppInsight: No description available. ,
DependencyGraph: No description available. ,
DownTime: No description available. ,
SummaryCard: No description available. ,
SearchComponent: No description available. ,
AppInsightEnablement: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
status:
{
Description: Indicates status of the most severe insight. ,
Required: False ,
}
{
message:
{
Description: Descriptive message. ,
Required: False ,
}
string ,
statusId:
{
Description: Level of the most severe insight generated by the detector. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Info: No description available. ,
Success: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataProvidersMetadata:
{
Description: Additional configuration for different data providers to be used by the UI ,
Required: False ,
}
[
{
providerName:
{
Required: False ,
}
string ,
propertyBag:
{
Description: Settings for the data provider ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
suggestedUtterances:
{
Description: Suggested utterances where the detector can be applicable. ,
Required: False ,
}
{
query:
{
Description: Search Query. ,
Required: False ,
}
string ,
results:
{
Description: Array of utterance results for search query. ,
Required: False ,
}
[
{
sampleUtterance:
{
Description: A sample utterance. ,
Required: False ,
}
{
text:
{
Description: Text attribute of sample utterance. ,
Required: False ,
}
string ,
links:
{
Description: Links attribute of sample utterance. ,
Required: False ,
}
[
string ,
]
,
qid:
{
Description: Question id of sample utterance (for stackoverflow questions titles). ,
Required: False ,
}
string ,
}
,
score:
{
Description: Score of a sample utterance. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}
,
]
,
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 ,
}
,
}
Diagnostics_GetSiteDetectorResponseSlot (new)
Description :  Description for Get site detector response
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
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: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
id:
{
Description: Id of detector ,
Required: False ,
}
string ,
name:
{
Description: Name of detector ,
Required: False ,
}
string ,
description:
{
Description: Short description of the detector and its purpose. ,
Required: False ,
}
string ,
author:
{
Description: Author of the detector. ,
Required: False ,
}
string ,
category:
{
Description: Problem category. This serves for organizing group for detectors. ,
Required: False ,
}
string ,
supportTopicList:
{
Description: List of Support Topics for which this detector is enabled. ,
Required: False ,
}
[
{
id:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
pesId:
{
Description: Unique resource Id ,
Required: False ,
}
string ,
}
,
]
,
analysisType:
{
Description: Analysis Types for which this detector should apply to. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Whether this detector is an Analysis Detector or not. ,
Enum:
{
Detector: No description available. ,
Analysis: No description available. ,
CategoryOverview: No description available. ,
}
,
Required: False ,
}
enum ,
score:
{
Description: Defines score of a detector to power ML based matching. ,
Format: float ,
Required: False ,
}
number ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
type:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
PieChart: No description available. ,
DataSummary: No description available. ,
Email: No description available. ,
Insights: No description available. ,
DynamicInsight: No description available. ,
Markdown: No description available. ,
Detector: No description available. ,
DropDown: No description available. ,
Card: No description available. ,
Solution: No description available. ,
Guage: No description available. ,
Form: No description available. ,
ChangeSets: No description available. ,
ChangeAnalysisOnboarding: No description available. ,
ChangesView: No description available. ,
AppInsight: No description available. ,
DependencyGraph: No description available. ,
DownTime: No description available. ,
SummaryCard: No description available. ,
SearchComponent: No description available. ,
AppInsightEnablement: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
status:
{
Description: Indicates status of the most severe insight. ,
Required: False ,
}
{
message:
{
Description: Descriptive message. ,
Required: False ,
}
string ,
statusId:
{
Description: Level of the most severe insight generated by the detector. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Info: No description available. ,
Success: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataProvidersMetadata:
{
Description: Additional configuration for different data providers to be used by the UI ,
Required: False ,
}
[
{
providerName:
{
Required: False ,
}
string ,
propertyBag:
{
Description: Settings for the data provider ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
suggestedUtterances:
{
Description: Suggested utterances where the detector can be applicable. ,
Required: False ,
}
{
query:
{
Description: Search Query. ,
Required: False ,
}
string ,
results:
{
Description: Array of utterance results for search query. ,
Required: False ,
}
[
{
sampleUtterance:
{
Description: A sample utterance. ,
Required: False ,
}
{
text:
{
Description: Text attribute of sample utterance. ,
Required: False ,
}
string ,
links:
{
Description: Links attribute of sample utterance. ,
Required: False ,
}
[
string ,
]
,
qid:
{
Description: Question id of sample utterance (for stackoverflow questions titles). ,
Required: False ,
}
string ,
}
,
score:
{
Description: Score of a sample utterance. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
}
,
}
Diagnostics_ListSiteDiagnosticCategoriesSlot (new)
Description :  Description for Get Diagnostics Categories
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
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: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
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 ,
}
,
}
Diagnostics_GetSiteDiagnosticCategorySlot (new)
Description :  Description for Get Diagnostics Category
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
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: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
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 ,
}
,
}
Diagnostics_ListSiteAnalysesSlot (new)
Description :  Description for Get Site Analyses
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
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: AnalysisDefinition resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the Analysis ,
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 ,
}
,
}
Diagnostics_GetSiteAnalysisSlot (new)
Description :  Description for Get Site Analysis
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
analysisName:
{
Description: Analysis Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot - optional ,
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: AnalysisDefinition resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the Analysis ,
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 ,
}
,
}
Diagnostics_ExecuteSiteAnalysisSlot (new)
Description :  Description for Execute Analysis
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
analysisName:
{
Description: Analysis Resource Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
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: DiagnosticAnalysis resource specific properties ,
Required: False ,
}
{
startTime:
{
Description: Start time of the period ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the period ,
Format: date-time ,
Required: False ,
}
string ,
abnormalTimePeriods:
{
Description: List of time periods. ,
Required: False ,
}
[
{
startTime:
{
Description: Start time of the downtime ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the downtime ,
Format: date-time ,
Required: False ,
}
string ,
events:
{
Description: List of Possible Cause of downtime ,
Required: False ,
}
[
{
startTime:
{
Description: Start time of the correlated event ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the correlated event ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Message describing the event ,
Required: False ,
}
string ,
source:
{
Description: Represents the name of the Detector ,
Required: False ,
}
string ,
priority:
{
Description: Represents the rank of the Detector ,
Format: double ,
Required: False ,
}
number ,
metaData:
{
Description: Downtime metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Represents the type of the Detector ,
Enum:
{
ServiceIncident: No description available. ,
AppDeployment: No description available. ,
AppCrash: No description available. ,
RuntimeIssueDetected: No description available. ,
AseDeployment: No description available. ,
UserIssue: No description available. ,
PlatformIssue: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of proposed solutions ,
Required: False ,
}
[
{
id:
{
Description: Solution Id. ,
Format: double ,
Required: False ,
}
number ,
displayName:
{
Description: Display Name of the solution ,
Required: False ,
}
string ,
order:
{
Description: Order of the solution. ,
Format: double ,
Required: False ,
}
number ,
description:
{
Description: Description of the solution ,
Required: False ,
}
string ,
type:
{
Description: Type of Solution ,
Enum:
{
QuickSolution: No description available. ,
DeepInvestigation: No description available. ,
BestPractices: No description available. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: Solution Data. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Solution Metadata. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
solutions:
{
Description: List of proposed solutions ,
Required: False ,
}
[
{
id:
{
Description: Solution Id. ,
Format: double ,
Required: False ,
}
number ,
displayName:
{
Description: Display Name of the solution ,
Required: False ,
}
string ,
order:
{
Description: Order of the solution. ,
Format: double ,
Required: False ,
}
number ,
description:
{
Description: Description of the solution ,
Required: False ,
}
string ,
type:
{
Description: Type of Solution ,
Enum:
{
QuickSolution: No description available. ,
DeepInvestigation: No description available. ,
BestPractices: No description available. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: Solution Data. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Solution Metadata. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
payload:
{
Description: Data by each detector ,
Required: False ,
}
[
{
source:
{
Description: Name of the Detector ,
Required: False ,
}
string ,
detectorDefinition:
{
Description: Detector Definition ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
metrics:
{
Description: Source Metrics ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Metric's unit ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the period ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the period ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D ,
Required: False ,
}
string ,
values:
{
Description: Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain} ,
Required: False ,
}
[
{
timestamp:
{
Description: Time at which metric is measured ,
Format: date-time ,
Required: False ,
}
string ,
roleInstance:
{
Description: Role Instance. Null if this counter is not per instance This is returned and should be whichever instance name we desire to be returned i.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0) where RDWORKERNAME is Machine name below and RoleInstance name in parenthesis ,
Required: False ,
}
string ,
total:
{
Description: Total value of the metric. If multiple measurements are made this will have sum of all. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: Maximum of the metric sampled during the time period ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: Minimum of the metric sampled during the time period ,
Format: double ,
Required: False ,
}
number ,
isAggregated:
{
Description: Whether the values are aggregates across all workers or not ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
data:
{
Description: Additional Source Data ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
detectorMetaData:
{
Description: Detector Meta Data ,
Required: False ,
}
{
dataSource:
{
Description: Source of the Data ,
Required: False ,
}
{
instructions:
{
Description: Instructions if any for the data source ,
Required: False ,
}
[
string ,
]
,
dataSourceUri:
{
Description: Datasource Uri Links ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nonCorrelatedDetectors:
{
Description: Data by each detector for detectors that did not corelate ,
Required: False ,
}
[
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
}
Diagnostics_ListSiteDetectorsSlot (new)
Description :  Description for Get Detectors
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
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 ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
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 ,
}
,
}
Diagnostics_GetSiteDetectorSlot (new)
Description :  Description for Get Detector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
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 ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
Diagnostics_ExecuteSiteDetectorSlot (new)
Description :  Description for Execute Detector
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
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: DiagnosticDetectorResponse resource specific properties ,
Required: False ,
}
{
startTime:
{
Description: Start time of the period ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the period ,
Format: date-time ,
Required: False ,
}
string ,
issueDetected:
{
Description: Flag representing Issue was detected. ,
Required: False ,
}
boolean ,
detectorDefinition:
{
Description: Detector's definition ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
metrics:
{
Description: Metrics provided by the detector ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Metric's unit ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the period ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the period ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D ,
Required: False ,
}
string ,
values:
{
Description: Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain} ,
Required: False ,
}
[
{
timestamp:
{
Description: Time at which metric is measured ,
Format: date-time ,
Required: False ,
}
string ,
roleInstance:
{
Description: Role Instance. Null if this counter is not per instance This is returned and should be whichever instance name we desire to be returned i.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0) where RDWORKERNAME is Machine name below and RoleInstance name in parenthesis ,
Required: False ,
}
string ,
total:
{
Description: Total value of the metric. If multiple measurements are made this will have sum of all. ,
Format: double ,
Required: False ,
}
number ,
maximum:
{
Description: Maximum of the metric sampled during the time period ,
Format: double ,
Required: False ,
}
number ,
minimum:
{
Description: Minimum of the metric sampled during the time period ,
Format: double ,
Required: False ,
}
number ,
isAggregated:
{
Description: Whether the values are aggregates across all workers or not ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
abnormalTimePeriods:
{
Description: List of Correlated events found by the detector ,
Required: False ,
}
[
{
startTime:
{
Description: Start time of the correlated event ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the correlated event ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Message describing the event ,
Required: False ,
}
string ,
source:
{
Description: Represents the name of the Detector ,
Required: False ,
}
string ,
priority:
{
Description: Represents the rank of the Detector ,
Format: double ,
Required: False ,
}
number ,
metaData:
{
Description: Downtime metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Represents the type of the Detector ,
Enum:
{
ServiceIncident: No description available. ,
AppDeployment: No description available. ,
AppCrash: No description available. ,
RuntimeIssueDetected: No description available. ,
AseDeployment: No description available. ,
UserIssue: No description available. ,
PlatformIssue: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of proposed solutions ,
Required: False ,
}
[
{
id:
{
Description: Solution Id. ,
Format: double ,
Required: False ,
}
number ,
displayName:
{
Description: Display Name of the solution ,
Required: False ,
}
string ,
order:
{
Description: Order of the solution. ,
Format: double ,
Required: False ,
}
number ,
description:
{
Description: Description of the solution ,
Required: False ,
}
string ,
type:
{
Description: Type of Solution ,
Enum:
{
QuickSolution: No description available. ,
DeepInvestigation: No description available. ,
BestPractices: No description available. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: Solution Data. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Solution Metadata. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
data:
{
Description: Additional Data that detector wants to send. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
responseMetaData:
{
Description: Meta Data ,
Required: False ,
}
{
dataSource:
{
Description: Source of the Data ,
Required: False ,
}
{
instructions:
{
Description: Instructions if any for the data source ,
Required: False ,
}
[
string ,
]
,
dataSourceUri:
{
Description: Datasource Uri Links ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
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 ,
}
,
}
Global_GetDeletedWebApp (new)
Description :  Description for Get deleted app for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}
{
deletedSiteId:
{
Description: The numeric ID of the deleted app, e.g. 12345 ,
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: DeletedSite resource specific properties ,
Required: False ,
}
{
deletedSiteId:
{
Description: Numeric id for the deleted site ,
Format: int32 ,
Required: False ,
}
integer ,
deletedTimestamp:
{
Description: Time in UTC when the app was deleted. ,
Required: False ,
}
string ,
subscription:
{
Description: Subscription containing the deleted site ,
Required: False ,
}
string ,
resourceGroup:
{
Description: ResourceGroup that contained the deleted site ,
Required: False ,
}
string ,
deletedSiteName:
{
Description: Name of the deleted site ,
Required: False ,
}
string ,
slot:
{
Description: Slot of the deleted site ,
Required: False ,
}
string ,
kind:
{
Description: Kind of site that was deleted ,
Required: False ,
}
string ,
geoRegionName:
{
Description: Geo Region of the deleted site ,
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 ,
}
,
}
Global_GetDeletedWebAppSnapshots (new)
Description :  Description for Get all deleted apps for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}/snapshots
{
deletedSiteId:
{
Description: The numeric ID of the deleted app, e.g. 12345 ,
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: Snapshot resource specific properties ,
Required: False ,
}
{
time:
{
Description: The time the snapshot was taken. ,
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 ,
}
,
}
Global_GetSubscriptionOperationWithAsyncResponse (new)
Description :  Description for Gets an operation in a subscription and given region
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
KubeEnvironments_ListBySubscription (new)
Description :  Description for Get all Kubernetes Environments for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/kubeEnvironments
{
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: KubeEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
internalLoadBalancerEnabled:
{
Description: Only visible within Vnet/Subnet ,
Required: False ,
}
boolean ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the KubeEnvironment ,
Required: False ,
}
string ,
environmentType:
{
Description: Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed ,
Required: False ,
}
string ,
arcConfiguration:
{
Description: Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. ,
Required: False ,
}
{
artifactsStorageType:
{
Enum:
{
LocalNode: No description available. ,
NetworkFileSystem: No description available. ,
}
,
Required: False ,
}
enum ,
artifactStorageClassName:
{
Required: False ,
}
string ,
artifactStorageMountPath:
{
Required: False ,
}
string ,
artifactStorageNodeName:
{
Required: False ,
}
string ,
artifactStorageAccessMode:
{
Required: False ,
}
string ,
frontEndServiceConfiguration:
{
Required: False ,
}
{
kind:
{
Enum:
{
NodePort: No description available. ,
LoadBalancer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kubeConfig:
{
Required: False ,
}
string ,
}
,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported ,
Required: False ,
}
{
destination:
{
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Required: False ,
}
{
customerId:
{
Required: False ,
}
string ,
sharedKey:
{
Required: False ,
}
string ,
}
,
}
,
containerAppsConfiguration:
{
Description: Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration ,
Required: False ,
}
{
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server ,
Required: False ,
}
string ,
controlPlaneSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
appSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
}
,
aksResourceID:
{
Required: False ,
}
string ,
}
,
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 ,
}
,
}
KubeEnvironments_ListByResourceGroup (new)
Description :  Description for Get all the Kubernetes Environments in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments
{
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: KubeEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
internalLoadBalancerEnabled:
{
Description: Only visible within Vnet/Subnet ,
Required: False ,
}
boolean ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the KubeEnvironment ,
Required: False ,
}
string ,
environmentType:
{
Description: Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed ,
Required: False ,
}
string ,
arcConfiguration:
{
Description: Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. ,
Required: False ,
}
{
artifactsStorageType:
{
Enum:
{
LocalNode: No description available. ,
NetworkFileSystem: No description available. ,
}
,
Required: False ,
}
enum ,
artifactStorageClassName:
{
Required: False ,
}
string ,
artifactStorageMountPath:
{
Required: False ,
}
string ,
artifactStorageNodeName:
{
Required: False ,
}
string ,
artifactStorageAccessMode:
{
Required: False ,
}
string ,
frontEndServiceConfiguration:
{
Required: False ,
}
{
kind:
{
Enum:
{
NodePort: No description available. ,
LoadBalancer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kubeConfig:
{
Required: False ,
}
string ,
}
,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported ,
Required: False ,
}
{
destination:
{
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Required: False ,
}
{
customerId:
{
Required: False ,
}
string ,
sharedKey:
{
Required: False ,
}
string ,
}
,
}
,
containerAppsConfiguration:
{
Description: Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration ,
Required: False ,
}
{
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server ,
Required: False ,
}
string ,
controlPlaneSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
appSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
}
,
aksResourceID:
{
Required: False ,
}
string ,
}
,
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 ,
}
,
}
KubeEnvironments_Get (new)
Description :  Description for Get the properties of a Kubernetes Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the Kubernetes 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: KubeEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
internalLoadBalancerEnabled:
{
Description: Only visible within Vnet/Subnet ,
Required: False ,
}
boolean ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the KubeEnvironment ,
Required: False ,
}
string ,
environmentType:
{
Description: Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed ,
Required: False ,
}
string ,
arcConfiguration:
{
Description: Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. ,
Required: False ,
}
{
artifactsStorageType:
{
Enum:
{
LocalNode: No description available. ,
NetworkFileSystem: No description available. ,
}
,
Required: False ,
}
enum ,
artifactStorageClassName:
{
Required: False ,
}
string ,
artifactStorageMountPath:
{
Required: False ,
}
string ,
artifactStorageNodeName:
{
Required: False ,
}
string ,
artifactStorageAccessMode:
{
Required: False ,
}
string ,
frontEndServiceConfiguration:
{
Required: False ,
}
{
kind:
{
Enum:
{
NodePort: No description available. ,
LoadBalancer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kubeConfig:
{
Required: False ,
}
string ,
}
,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported ,
Required: False ,
}
{
destination:
{
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Required: False ,
}
{
customerId:
{
Required: False ,
}
string ,
sharedKey:
{
Required: False ,
}
string ,
}
,
}
,
containerAppsConfiguration:
{
Description: Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration ,
Required: False ,
}
{
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server ,
Required: False ,
}
string ,
controlPlaneSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
appSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
}
,
aksResourceID:
{
Required: False ,
}
string ,
}
,
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 ,
}
,
}
KubeEnvironments_CreateOrUpdate (new)
Description :  Description for Creates or updates a Kubernetes Environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: True ,
}
string ,
kubeEnvironmentEnvelope:
{
Description: Configuration details of the Kubernetes Environment. ,
Required: True ,
}
{
properties:
{
Description: KubeEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
internalLoadBalancerEnabled:
{
Description: Only visible within Vnet/Subnet ,
Required: False ,
}
boolean ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the KubeEnvironment ,
Required: False ,
}
string ,
environmentType:
{
Description: Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed ,
Required: False ,
}
string ,
arcConfiguration:
{
Description: Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. ,
Required: False ,
}
{
artifactsStorageType:
{
Enum:
{
LocalNode: No description available. ,
NetworkFileSystem: No description available. ,
}
,
Required: False ,
}
enum ,
artifactStorageClassName:
{
Required: False ,
}
string ,
artifactStorageMountPath:
{
Required: False ,
}
string ,
artifactStorageNodeName:
{
Required: False ,
}
string ,
artifactStorageAccessMode:
{
Required: False ,
}
string ,
frontEndServiceConfiguration:
{
Required: False ,
}
{
kind:
{
Enum:
{
NodePort: No description available. ,
LoadBalancer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kubeConfig:
{
Required: False ,
}
string ,
}
,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported ,
Required: False ,
}
{
destination:
{
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Required: False ,
}
{
customerId:
{
Required: False ,
}
string ,
sharedKey:
{
Required: False ,
}
string ,
}
,
}
,
containerAppsConfiguration:
{
Description: Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration ,
Required: False ,
}
{
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server ,
Required: False ,
}
string ,
controlPlaneSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
appSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
}
,
aksResourceID:
{
Required: False ,
}
string ,
}
,
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: KubeEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
internalLoadBalancerEnabled:
{
Description: Only visible within Vnet/Subnet ,
Required: False ,
}
boolean ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the KubeEnvironment ,
Required: False ,
}
string ,
environmentType:
{
Description: Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed ,
Required: False ,
}
string ,
arcConfiguration:
{
Description: Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. ,
Required: False ,
}
{
artifactsStorageType:
{
Enum:
{
LocalNode: No description available. ,
NetworkFileSystem: No description available. ,
}
,
Required: False ,
}
enum ,
artifactStorageClassName:
{
Required: False ,
}
string ,
artifactStorageMountPath:
{
Required: False ,
}
string ,
artifactStorageNodeName:
{
Required: False ,
}
string ,
artifactStorageAccessMode:
{
Required: False ,
}
string ,
frontEndServiceConfiguration:
{
Required: False ,
}
{
kind:
{
Enum:
{
NodePort: No description available. ,
LoadBalancer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kubeConfig:
{
Required: False ,
}
string ,
}
,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported ,
Required: False ,
}
{
destination:
{
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Required: False ,
}
{
customerId:
{
Required: False ,
}
string ,
sharedKey:
{
Required: False ,
}
string ,
}
,
}
,
containerAppsConfiguration:
{
Description: Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration ,
Required: False ,
}
{
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server ,
Required: False ,
}
string ,
controlPlaneSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
appSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
}
,
aksResourceID:
{
Required: False ,
}
string ,
}
,
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 (201)

{
properties:
{
Description: KubeEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
internalLoadBalancerEnabled:
{
Description: Only visible within Vnet/Subnet ,
Required: False ,
}
boolean ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the KubeEnvironment ,
Required: False ,
}
string ,
environmentType:
{
Description: Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed ,
Required: False ,
}
string ,
arcConfiguration:
{
Description: Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. ,
Required: False ,
}
{
artifactsStorageType:
{
Enum:
{
LocalNode: No description available. ,
NetworkFileSystem: No description available. ,
}
,
Required: False ,
}
enum ,
artifactStorageClassName:
{
Required: False ,
}
string ,
artifactStorageMountPath:
{
Required: False ,
}
string ,
artifactStorageNodeName:
{
Required: False ,
}
string ,
artifactStorageAccessMode:
{
Required: False ,
}
string ,
frontEndServiceConfiguration:
{
Required: False ,
}
{
kind:
{
Enum:
{
NodePort: No description available. ,
LoadBalancer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kubeConfig:
{
Required: False ,
}
string ,
}
,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported ,
Required: False ,
}
{
destination:
{
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Required: False ,
}
{
customerId:
{
Required: False ,
}
string ,
sharedKey:
{
Required: False ,
}
string ,
}
,
}
,
containerAppsConfiguration:
{
Description: Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration ,
Required: False ,
}
{
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server ,
Required: False ,
}
string ,
controlPlaneSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
appSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
}
,
aksResourceID:
{
Required: False ,
}
string ,
}
,
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 ,
}
,
}
KubeEnvironments_Delete (new)
Description :  Description for Delete a Kubernetes Environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the Kubernetes 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 (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 ,
}
,
}
KubeEnvironments_Update (new)
Description :  Description for Creates or updates a Kubernetes Environment.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the Kubernetes Environment. ,
Required: True ,
}
string ,
kubeEnvironmentEnvelope:
{
Description: Configuration details of the Kubernetes Environment. ,
Required: True ,
}
{
properties:
{
Description: KubeEnvironmentPatchResource resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
internalLoadBalancerEnabled:
{
Description: Only visible within Vnet/Subnet ,
Required: False ,
}
boolean ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the KubeEnvironment ,
Required: False ,
}
string ,
arcConfiguration:
{
Description: Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. ,
Required: False ,
}
{
artifactsStorageType:
{
Enum:
{
LocalNode: No description available. ,
NetworkFileSystem: No description available. ,
}
,
Required: False ,
}
enum ,
artifactStorageClassName:
{
Required: False ,
}
string ,
artifactStorageMountPath:
{
Required: False ,
}
string ,
artifactStorageNodeName:
{
Required: False ,
}
string ,
artifactStorageAccessMode:
{
Required: False ,
}
string ,
frontEndServiceConfiguration:
{
Required: False ,
}
{
kind:
{
Enum:
{
NodePort: No description available. ,
LoadBalancer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kubeConfig:
{
Required: False ,
}
string ,
}
,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported ,
Required: False ,
}
{
destination:
{
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Required: False ,
}
{
customerId:
{
Required: False ,
}
string ,
sharedKey:
{
Required: False ,
}
string ,
}
,
}
,
containerAppsConfiguration:
{
Description: Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration ,
Required: False ,
}
{
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server ,
Required: False ,
}
string ,
controlPlaneSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
appSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
}
,
aksResourceID:
{
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: KubeEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
internalLoadBalancerEnabled:
{
Description: Only visible within Vnet/Subnet ,
Required: False ,
}
boolean ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the KubeEnvironment ,
Required: False ,
}
string ,
environmentType:
{
Description: Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed ,
Required: False ,
}
string ,
arcConfiguration:
{
Description: Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. ,
Required: False ,
}
{
artifactsStorageType:
{
Enum:
{
LocalNode: No description available. ,
NetworkFileSystem: No description available. ,
}
,
Required: False ,
}
enum ,
artifactStorageClassName:
{
Required: False ,
}
string ,
artifactStorageMountPath:
{
Required: False ,
}
string ,
artifactStorageNodeName:
{
Required: False ,
}
string ,
artifactStorageAccessMode:
{
Required: False ,
}
string ,
frontEndServiceConfiguration:
{
Required: False ,
}
{
kind:
{
Enum:
{
NodePort: No description available. ,
LoadBalancer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kubeConfig:
{
Required: False ,
}
string ,
}
,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported ,
Required: False ,
}
{
destination:
{
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Required: False ,
}
{
customerId:
{
Required: False ,
}
string ,
sharedKey:
{
Required: False ,
}
string ,
}
,
}
,
containerAppsConfiguration:
{
Description: Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration ,
Required: False ,
}
{
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server ,
Required: False ,
}
string ,
controlPlaneSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
appSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
}
,
aksResourceID:
{
Required: False ,
}
string ,
}
,
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 (201)

{
properties:
{
Description: KubeEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
internalLoadBalancerEnabled:
{
Description: Only visible within Vnet/Subnet ,
Required: False ,
}
boolean ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the KubeEnvironment ,
Required: False ,
}
string ,
environmentType:
{
Description: Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed ,
Required: False ,
}
string ,
arcConfiguration:
{
Description: Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. ,
Required: False ,
}
{
artifactsStorageType:
{
Enum:
{
LocalNode: No description available. ,
NetworkFileSystem: No description available. ,
}
,
Required: False ,
}
enum ,
artifactStorageClassName:
{
Required: False ,
}
string ,
artifactStorageMountPath:
{
Required: False ,
}
string ,
artifactStorageNodeName:
{
Required: False ,
}
string ,
artifactStorageAccessMode:
{
Required: False ,
}
string ,
frontEndServiceConfiguration:
{
Required: False ,
}
{
kind:
{
Enum:
{
NodePort: No description available. ,
LoadBalancer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kubeConfig:
{
Required: False ,
}
string ,
}
,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported ,
Required: False ,
}
{
destination:
{
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Required: False ,
}
{
customerId:
{
Required: False ,
}
string ,
sharedKey:
{
Required: False ,
}
string ,
}
,
}
,
containerAppsConfiguration:
{
Description: Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration ,
Required: False ,
}
{
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server ,
Required: False ,
}
string ,
controlPlaneSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
appSubnetResourceId:
{
Description: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. ,
Required: False ,
}
string ,
}
,
aksResourceID:
{
Required: False ,
}
string ,
}
,
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 ,
}
,
}
Provider_GetAvailableStacks (new)
Description :  Description for Get available application frameworks and their versions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Web/availableStacks
{
osTypeSelected:
{
Required: False ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Application stack name. ,
Required: False ,
}
string ,
display:
{
Description: Application stack display name. ,
Required: False ,
}
string ,
dependency:
{
Description: Application stack dependency. ,
Required: False ,
}
string ,
majorVersions:
{
Description: List of major versions available. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack major version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack major version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default major version; otherwise, false. ,
Required: False ,
}
boolean ,
minorVersions:
{
Description: Minor versions associated with the major version. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack minor version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack minor version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default minor version; otherwise, false. ,
Required: False ,
}
boolean ,
isRemoteDebuggingEnabled:
{
Description: true if this supports Remote Debugging, otherwise false. ,
Required: False ,
}
boolean ,
}
,
]
,
applicationInsights:
{
Description: true if this supports Application Insights; otherwise, false. ,
Required: False ,
}
boolean ,
isPreview:
{
Description: true if this stack is in Preview, otherwise false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if this stack has been deprecated, otherwise false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if this stack should be hidden for new customers on portal, otherwise false. ,
Required: False ,
}
boolean ,
appSettingsDictionary:
{
Description: Example: All the function apps need AppSetting: "FUNCTIONS_WORKER_RUNTIME" to be set stack name ,
Required: False ,
}
object ,
siteConfigPropertiesDictionary:
{
Description: Example: All Linux Function Apps, need Use32BitWorkerProcess to be set to 0 ,
Required: False ,
}
object ,
}
,
]
,
frameworks:
{
Description: List of frameworks associated with application stack. ,
Required: False ,
}
[
string ,
]
,
isDeprecated:
{
Description: true if this is the stack is deprecated; otherwise, false. ,
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 ,
}
,
}
Provider_GetFunctionAppStacks (new)
Description :  Description for Get available Function app frameworks and their versions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Web/functionAppStacks
{
stackOsType:
{
Description: Stack OS Type ,
Required: False ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
location:
{
Description: Function App stack location. ,
Required: False ,
}
string ,
properties:
{
Description: FunctionAppStack resource specific properties ,
Required: False ,
}
{
displayText:
{
Description: Function App stack (display only). ,
Required: False ,
}
string ,
value:
{
Description: Function App stack name. ,
Required: False ,
}
string ,
majorVersions:
{
Description: List of major versions available. ,
Required: False ,
}
[
{
displayText:
{
Description: Function App stack major version (display only). ,
Required: False ,
}
string ,
value:
{
Description: Function App stack major version name. ,
Required: False ,
}
string ,
minorVersions:
{
Description: Minor versions associated with the major version. ,
Required: False ,
}
[
{
displayText:
{
Description: Function App stack (display only). ,
Required: False ,
}
string ,
value:
{
Description: Function App stack name. ,
Required: False ,
}
string ,
stackSettings:
{
Description: Settings associated with the minor version. ,
Required: False ,
}
{
linuxRuntimeSettings:
{
Description: Linux-specific settings associated with the minor version. ,
Required: False ,
}
{
runtimeVersion:
{
Description: Function App stack minor version (runtime only). ,
Required: False ,
}
string ,
remoteDebuggingSupported:
{
Description: true if remote debugging is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
appInsightsSettings:
{
Description: Application Insights settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if remote Application Insights is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
isDefaultOff:
{
Description: true if Application Insights is disabled by default for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
gitHubActionSettings:
{
Description: GitHub Actions settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if GitHub Actions is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
supportedVersion:
{
Description: The minor version that is supported for GitHub Actions. ,
Required: False ,
}
string ,
}
,
appSettingsDictionary:
{
Description: Application settings associated with the minor version. ,
Required: False ,
}
object ,
siteConfigPropertiesDictionary:
{
Description: Configuration settings associated with the minor version. ,
Required: False ,
}
{
use32BitWorkerProcess:
{
Description: true if use32BitWorkerProcess should be set to true for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
linuxFxVersion:
{
Description: LinuxFxVersion configuration setting. ,
Required: False ,
}
string ,
javaVersion:
{
Description: JavaVersion configuration setting. ,
Required: False ,
}
string ,
powerShellVersion:
{
Description: PowerShellVersion configuration setting. ,
Required: False ,
}
string ,
}
,
supportedFunctionsExtensionVersions:
{
Description: List of supported Functions extension versions. ,
Required: False ,
}
[
string ,
]
,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
isDefault:
{
Description: true if the minor version the default; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
windowsRuntimeSettings:
{
Description: Windows-specific settings associated with the minor version. ,
Required: False ,
}
{
runtimeVersion:
{
Description: Function App stack minor version (runtime only). ,
Required: False ,
}
string ,
remoteDebuggingSupported:
{
Description: true if remote debugging is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
appInsightsSettings:
{
Description: Application Insights settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if remote Application Insights is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
isDefaultOff:
{
Description: true if Application Insights is disabled by default for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
gitHubActionSettings:
{
Description: GitHub Actions settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if GitHub Actions is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
supportedVersion:
{
Description: The minor version that is supported for GitHub Actions. ,
Required: False ,
}
string ,
}
,
appSettingsDictionary:
{
Description: Application settings associated with the minor version. ,
Required: False ,
}
object ,
siteConfigPropertiesDictionary:
{
Description: Configuration settings associated with the minor version. ,
Required: False ,
}
{
use32BitWorkerProcess:
{
Description: true if use32BitWorkerProcess should be set to true for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
linuxFxVersion:
{
Description: LinuxFxVersion configuration setting. ,
Required: False ,
}
string ,
javaVersion:
{
Description: JavaVersion configuration setting. ,
Required: False ,
}
string ,
powerShellVersion:
{
Description: PowerShellVersion configuration setting. ,
Required: False ,
}
string ,
}
,
supportedFunctionsExtensionVersions:
{
Description: List of supported Functions extension versions. ,
Required: False ,
}
[
string ,
]
,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
isDefault:
{
Description: true if the minor version the default; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
]
,
preferredOs:
{
Description: Function App stack preferred OS. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
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 ,
}
,
}
Provider_GetFunctionAppStacksForLocation (new)
Description :  Description for Get available Function app frameworks and their versions for location
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Web/locations/{location}/functionAppStacks
{
location:
{
Description: Function App stack location. ,
Required: True ,
}
string ,
stackOsType:
{
Description: Stack OS Type ,
Required: False ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
location:
{
Description: Function App stack location. ,
Required: False ,
}
string ,
properties:
{
Description: FunctionAppStack resource specific properties ,
Required: False ,
}
{
displayText:
{
Description: Function App stack (display only). ,
Required: False ,
}
string ,
value:
{
Description: Function App stack name. ,
Required: False ,
}
string ,
majorVersions:
{
Description: List of major versions available. ,
Required: False ,
}
[
{
displayText:
{
Description: Function App stack major version (display only). ,
Required: False ,
}
string ,
value:
{
Description: Function App stack major version name. ,
Required: False ,
}
string ,
minorVersions:
{
Description: Minor versions associated with the major version. ,
Required: False ,
}
[
{
displayText:
{
Description: Function App stack (display only). ,
Required: False ,
}
string ,
value:
{
Description: Function App stack name. ,
Required: False ,
}
string ,
stackSettings:
{
Description: Settings associated with the minor version. ,
Required: False ,
}
{
linuxRuntimeSettings:
{
Description: Linux-specific settings associated with the minor version. ,
Required: False ,
}
{
runtimeVersion:
{
Description: Function App stack minor version (runtime only). ,
Required: False ,
}
string ,
remoteDebuggingSupported:
{
Description: true if remote debugging is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
appInsightsSettings:
{
Description: Application Insights settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if remote Application Insights is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
isDefaultOff:
{
Description: true if Application Insights is disabled by default for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
gitHubActionSettings:
{
Description: GitHub Actions settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if GitHub Actions is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
supportedVersion:
{
Description: The minor version that is supported for GitHub Actions. ,
Required: False ,
}
string ,
}
,
appSettingsDictionary:
{
Description: Application settings associated with the minor version. ,
Required: False ,
}
object ,
siteConfigPropertiesDictionary:
{
Description: Configuration settings associated with the minor version. ,
Required: False ,
}
{
use32BitWorkerProcess:
{
Description: true if use32BitWorkerProcess should be set to true for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
linuxFxVersion:
{
Description: LinuxFxVersion configuration setting. ,
Required: False ,
}
string ,
javaVersion:
{
Description: JavaVersion configuration setting. ,
Required: False ,
}
string ,
powerShellVersion:
{
Description: PowerShellVersion configuration setting. ,
Required: False ,
}
string ,
}
,
supportedFunctionsExtensionVersions:
{
Description: List of supported Functions extension versions. ,
Required: False ,
}
[
string ,
]
,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
isDefault:
{
Description: true if the minor version the default; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
windowsRuntimeSettings:
{
Description: Windows-specific settings associated with the minor version. ,
Required: False ,
}
{
runtimeVersion:
{
Description: Function App stack minor version (runtime only). ,
Required: False ,
}
string ,
remoteDebuggingSupported:
{
Description: true if remote debugging is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
appInsightsSettings:
{
Description: Application Insights settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if remote Application Insights is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
isDefaultOff:
{
Description: true if Application Insights is disabled by default for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
gitHubActionSettings:
{
Description: GitHub Actions settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if GitHub Actions is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
supportedVersion:
{
Description: The minor version that is supported for GitHub Actions. ,
Required: False ,
}
string ,
}
,
appSettingsDictionary:
{
Description: Application settings associated with the minor version. ,
Required: False ,
}
object ,
siteConfigPropertiesDictionary:
{
Description: Configuration settings associated with the minor version. ,
Required: False ,
}
{
use32BitWorkerProcess:
{
Description: true if use32BitWorkerProcess should be set to true for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
linuxFxVersion:
{
Description: LinuxFxVersion configuration setting. ,
Required: False ,
}
string ,
javaVersion:
{
Description: JavaVersion configuration setting. ,
Required: False ,
}
string ,
powerShellVersion:
{
Description: PowerShellVersion configuration setting. ,
Required: False ,
}
string ,
}
,
supportedFunctionsExtensionVersions:
{
Description: List of supported Functions extension versions. ,
Required: False ,
}
[
string ,
]
,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
isDefault:
{
Description: true if the minor version the default; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
]
,
preferredOs:
{
Description: Function App stack preferred OS. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
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 ,
}
,
}
Provider_GetWebAppStacksForLocation (new)
Description :  Description for Get available Web app frameworks and their versions for location
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Web/locations/{location}/webAppStacks
{
location:
{
Description: Web App stack location. ,
Required: True ,
}
string ,
stackOsType:
{
Description: Stack OS Type ,
Required: False ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
location:
{
Description: Web App stack location. ,
Required: False ,
}
string ,
properties:
{
Description: WebAppStack resource specific properties ,
Required: False ,
}
{
displayText:
{
Description: Web App stack (display only). ,
Required: False ,
}
string ,
value:
{
Description: Web App stack name. ,
Required: False ,
}
string ,
majorVersions:
{
Description: List of major versions available. ,
Required: False ,
}
[
{
displayText:
{
Description: Web App stack major version (display only). ,
Required: False ,
}
string ,
value:
{
Description: Web App stack major version name. ,
Required: False ,
}
string ,
minorVersions:
{
Description: Minor versions associated with the major version. ,
Required: False ,
}
[
{
displayText:
{
Description: Web App stack minor version (display only). ,
Required: False ,
}
string ,
value:
{
Description: Web App stack major version name. ,
Required: False ,
}
string ,
stackSettings:
{
Description: Settings associated with the minor version. ,
Required: False ,
}
{
linuxRuntimeSettings:
{
Description: Linux-specific settings associated with the minor version. ,
Required: False ,
}
{
runtimeVersion:
{
Description: Web App stack minor version (runtime only). ,
Required: False ,
}
string ,
remoteDebuggingSupported:
{
Description: true if remote debugging is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
appInsightsSettings:
{
Description: Application Insights settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if remote Application Insights is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
isDefaultOff:
{
Description: true if Application Insights is disabled by default for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
gitHubActionSettings:
{
Description: GitHub Actions settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if GitHub Actions is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
supportedVersion:
{
Description: The minor version that is supported for GitHub Actions. ,
Required: False ,
}
string ,
}
,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
windowsRuntimeSettings:
{
Description: Windows-specific settings associated with the minor version. ,
Required: False ,
}
{
runtimeVersion:
{
Description: Web App stack minor version (runtime only). ,
Required: False ,
}
string ,
remoteDebuggingSupported:
{
Description: true if remote debugging is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
appInsightsSettings:
{
Description: Application Insights settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if remote Application Insights is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
isDefaultOff:
{
Description: true if Application Insights is disabled by default for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
gitHubActionSettings:
{
Description: GitHub Actions settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if GitHub Actions is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
supportedVersion:
{
Description: The minor version that is supported for GitHub Actions. ,
Required: False ,
}
string ,
}
,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
linuxContainerSettings:
{
Description: Linux-specific settings associated with the Java container minor version. ,
Required: False ,
}
{
java11Runtime:
{
Description: Java 11 version (runtime only). ,
Required: False ,
}
string ,
java8Runtime:
{
Description: Java 8 version (runtime only). ,
Required: False ,
}
string ,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
windowsContainerSettings:
{
Description: Windows-specific settings associated with the Java container minor version. ,
Required: False ,
}
{
javaContainer:
{
Description: Java container (runtime only). ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version (runtime only). ,
Required: False ,
}
string ,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
]
,
preferredOs:
{
Description: Web App stack preferred OS. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
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 ,
}
,
}
Provider_ListOperations (new)
Description :  Description for Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Web/operations
{
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Required: False ,
}
string ,
isDataAction:
{
Required: False ,
}
boolean ,
display:
{
Description: Meta data about operation used for display in portal. ,
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
operation:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
origin:
{
Required: False ,
}
string ,
properties:
{
Description: Properties available for a Microsoft.Web resource provider operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Resource metrics service provided by Microsoft.Insights resource provider. ,
Required: False ,
}
{
metricSpecifications:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
displayDescription:
{
Required: False ,
}
string ,
unit:
{
Required: False ,
}
string ,
aggregationType:
{
Required: False ,
}
string ,
supportsInstanceLevelAggregation:
{
Required: False ,
}
boolean ,
enableRegionalMdmAccount:
{
Required: False ,
}
boolean ,
sourceMdmAccount:
{
Required: False ,
}
string ,
sourceMdmNamespace:
{
Required: False ,
}
string ,
metricFilterPattern:
{
Required: False ,
}
string ,
fillGapWithZero:
{
Required: False ,
}
boolean ,
isInternal:
{
Required: False ,
}
boolean ,
dimensions:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
internalName:
{
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Required: False ,
}
boolean ,
}
,
]
,
category:
{
Required: False ,
}
string ,
availabilities:
{
Required: False ,
}
[
{
timeGrain:
{
Required: False ,
}
string ,
blobDuration:
{
Required: False ,
}
string ,
}
,
]
,
supportedTimeGrainTypes:
{
Required: False ,
}
[
string ,
]
,
supportedAggregationTypes:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
logSpecifications:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
blobDuration:
{
Required: False ,
}
string ,
logFilterPattern:
{
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 ,
}
,
}
Provider_GetWebAppStacks (new)
Description :  Description for Get available Web app frameworks and their versions
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Web/webAppStacks
{
stackOsType:
{
Description: Stack OS Type ,
Required: False ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
location:
{
Description: Web App stack location. ,
Required: False ,
}
string ,
properties:
{
Description: WebAppStack resource specific properties ,
Required: False ,
}
{
displayText:
{
Description: Web App stack (display only). ,
Required: False ,
}
string ,
value:
{
Description: Web App stack name. ,
Required: False ,
}
string ,
majorVersions:
{
Description: List of major versions available. ,
Required: False ,
}
[
{
displayText:
{
Description: Web App stack major version (display only). ,
Required: False ,
}
string ,
value:
{
Description: Web App stack major version name. ,
Required: False ,
}
string ,
minorVersions:
{
Description: Minor versions associated with the major version. ,
Required: False ,
}
[
{
displayText:
{
Description: Web App stack minor version (display only). ,
Required: False ,
}
string ,
value:
{
Description: Web App stack major version name. ,
Required: False ,
}
string ,
stackSettings:
{
Description: Settings associated with the minor version. ,
Required: False ,
}
{
linuxRuntimeSettings:
{
Description: Linux-specific settings associated with the minor version. ,
Required: False ,
}
{
runtimeVersion:
{
Description: Web App stack minor version (runtime only). ,
Required: False ,
}
string ,
remoteDebuggingSupported:
{
Description: true if remote debugging is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
appInsightsSettings:
{
Description: Application Insights settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if remote Application Insights is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
isDefaultOff:
{
Description: true if Application Insights is disabled by default for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
gitHubActionSettings:
{
Description: GitHub Actions settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if GitHub Actions is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
supportedVersion:
{
Description: The minor version that is supported for GitHub Actions. ,
Required: False ,
}
string ,
}
,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
windowsRuntimeSettings:
{
Description: Windows-specific settings associated with the minor version. ,
Required: False ,
}
{
runtimeVersion:
{
Description: Web App stack minor version (runtime only). ,
Required: False ,
}
string ,
remoteDebuggingSupported:
{
Description: true if remote debugging is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
appInsightsSettings:
{
Description: Application Insights settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if remote Application Insights is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
isDefaultOff:
{
Description: true if Application Insights is disabled by default for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
gitHubActionSettings:
{
Description: GitHub Actions settings associated with the minor version. ,
Required: False ,
}
{
isSupported:
{
Description: true if GitHub Actions is supported for the stack; otherwise, false. ,
Required: False ,
}
boolean ,
supportedVersion:
{
Description: The minor version that is supported for GitHub Actions. ,
Required: False ,
}
string ,
}
,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
linuxContainerSettings:
{
Description: Linux-specific settings associated with the Java container minor version. ,
Required: False ,
}
{
java11Runtime:
{
Description: Java 11 version (runtime only). ,
Required: False ,
}
string ,
java8Runtime:
{
Description: Java 8 version (runtime only). ,
Required: False ,
}
string ,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
windowsContainerSettings:
{
Description: Windows-specific settings associated with the Java container minor version. ,
Required: False ,
}
{
javaContainer:
{
Description: Java container (runtime only). ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version (runtime only). ,
Required: False ,
}
string ,
isPreview:
{
Description: true if the stack is in preview; otherwise, false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if the stack is deprecated; otherwise, false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if the stack should be hidden; otherwise, false. ,
Required: False ,
}
boolean ,
endOfLifeDate:
{
Description: End-of-life date for the minor version. ,
Format: date-time ,
Required: False ,
}
string ,
isAutoUpdate:
{
Description: true if the stack version is auto-updated; otherwise, false. ,
Required: False ,
}
boolean ,
isEarlyAccess:
{
Description: true if the minor version is early-access; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
]
,
preferredOs:
{
Description: Web App stack preferred OS. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
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 ,
}
,
}
Provider_GetAvailableStacksOnPrem (new)
Description :  Description for Get available application frameworks and their versions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/availableStacks
{
osTypeSelected:
{
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: Core resource properties ,
Required: False ,
}
{
name:
{
Description: Application stack name. ,
Required: False ,
}
string ,
display:
{
Description: Application stack display name. ,
Required: False ,
}
string ,
dependency:
{
Description: Application stack dependency. ,
Required: False ,
}
string ,
majorVersions:
{
Description: List of major versions available. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack major version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack major version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default major version; otherwise, false. ,
Required: False ,
}
boolean ,
minorVersions:
{
Description: Minor versions associated with the major version. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack minor version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack minor version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default minor version; otherwise, false. ,
Required: False ,
}
boolean ,
isRemoteDebuggingEnabled:
{
Description: true if this supports Remote Debugging, otherwise false. ,
Required: False ,
}
boolean ,
}
,
]
,
applicationInsights:
{
Description: true if this supports Application Insights; otherwise, false. ,
Required: False ,
}
boolean ,
isPreview:
{
Description: true if this stack is in Preview, otherwise false. ,
Required: False ,
}
boolean ,
isDeprecated:
{
Description: true if this stack has been deprecated, otherwise false. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: true if this stack should be hidden for new customers on portal, otherwise false. ,
Required: False ,
}
boolean ,
appSettingsDictionary:
{
Description: Example: All the function apps need AppSetting: "FUNCTIONS_WORKER_RUNTIME" to be set stack name ,
Required: False ,
}
object ,
siteConfigPropertiesDictionary:
{
Description: Example: All Linux Function Apps, need Use32BitWorkerProcess to be set to 0 ,
Required: False ,
}
object ,
}
,
]
,
frameworks:
{
Description: List of frameworks associated with application stack. ,
Required: False ,
}
[
string ,
]
,
isDeprecated:
{
Description: true if this is the stack is deprecated; otherwise, false. ,
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 ,
}
,
}
Recommendations_List (new)
Description :  Description for List all recommendations for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations
{
featured:
{
Description: Specify true to return only the most critical recommendations. The default is false, which returns all recommendations. ,
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 ,
$filter:
{
Description: Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D] ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
categoryTags:
{
Description: The list of category tags that this recommendation belongs to. ,
Required: False ,
}
[
string ,
]
,
actionName:
{
Description: Name of action recommended by this object. ,
Required: False ,
}
string ,
enabled:
{
Description: True if this recommendation is still valid (i.e. "actionable"). False if it is invalid. ,
Format: int32 ,
Required: False ,
}
integer ,
states:
{
Description: The list of states of this recommendation. If it's null then it should be considered "Active". ,
Required: False ,
}
[
string ,
]
,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
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 ,
}
,
}
Recommendations_ResetAllFilters (new)
Description :  Description for Reset all recommendation opt-out settings for a subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations/reset
{
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 ,
}
,
}
Recommendations_DisableRecommendationForSubscription (new)
Description :  Description for Disables the specified rule so it will not apply to a subscription in the future.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations/{name}/disable
{
name:
{
Description: Rule name ,
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 ,
}
,
}
Recommendations_ListHistoryForHostingEnvironment (new)
Description :  Description for Get past recommendations for an app, optionally specified by the time range.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendationHistory
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
hostingEnvironmentName:
{
Description: Name of the hosting environment. ,
Required: True ,
}
string ,
expiredOnly:
{
Description: Specify false to return all recommendations. The default is true, which returns only expired recommendations. ,
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 ,
$filter:
{
Description: Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D] ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
categoryTags:
{
Description: The list of category tags that this recommendation belongs to. ,
Required: False ,
}
[
string ,
]
,
actionName:
{
Description: Name of action recommended by this object. ,
Required: False ,
}
string ,
enabled:
{
Description: True if this recommendation is still valid (i.e. "actionable"). False if it is invalid. ,
Format: int32 ,
Required: False ,
}
integer ,
states:
{
Description: The list of states of this recommendation. If it's null then it should be considered "Active". ,
Required: False ,
}
[
string ,
]
,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
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 ,
}
,
}
Recommendations_ListRecommendedRulesForHostingEnvironment (new)
Description :  Description for Get all recommendations for a hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
hostingEnvironmentName:
{
Description: Name of the app. ,
Required: True ,
}
string ,
featured:
{
Description: Specify true to return only the most critical recommendations. The default is false, which returns all recommendations. ,
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 ,
$filter:
{
Description: Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
categoryTags:
{
Description: The list of category tags that this recommendation belongs to. ,
Required: False ,
}
[
string ,
]
,
actionName:
{
Description: Name of action recommended by this object. ,
Required: False ,
}
string ,
enabled:
{
Description: True if this recommendation is still valid (i.e. "actionable"). False if it is invalid. ,
Format: int32 ,
Required: False ,
}
integer ,
states:
{
Description: The list of states of this recommendation. If it's null then it should be considered "Active". ,
Required: False ,
}
[
string ,
]
,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
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 ,
}
,
}
Recommendations_DisableAllForHostingEnvironment (new)
Description :  Description for Disable all recommendations for an app.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Recommendations_ResetAllFiltersForHostingEnvironment (new)
Description :  Description for Reset all recommendation opt-out settings for an app.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Recommendations_GetRuleDetailsByHostingEnvironment (new)
Description :  Description for Get a recommendation rule for an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
hostingEnvironmentName:
{
Description: Name of the hosting environment. ,
Required: True ,
}
string ,
name:
{
Description: Name of the recommendation. ,
Required: True ,
}
string ,
updateSeen:
{
Description: Specify true to update the last-seen timestamp of the recommendation object. ,
Required: False ,
}
boolean ,
recommendationId:
{
Description: The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry. ,
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: RecommendationRule resource specific properties ,
Required: False ,
}
{
recommendationName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule. ,
Required: False ,
}
string ,
message:
{
Description: Localized name of the rule (Good for UI). ,
Required: False ,
}
string ,
recommendationId:
{
Description: Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn't exist, it is set to null. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: Localized detailed description of the rule. ,
Required: False ,
}
string ,
actionName:
{
Description: Name of action that is recommended by this rule in string. ,
Required: False ,
}
string ,
level:
{
Description: Level of impact indicating how critical this rule is. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of available channels that this rule applies. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
categoryTags:
{
Description: The list of category tags that this recommendation rule belongs to. ,
Required: False ,
}
[
string ,
]
,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. Applicable to dynamic rule only. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. Applicable to dynamic rule only. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. Applicable to dynamic rule only. ,
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 ,
}
,
}
Recommendations_DisableRecommendationForHostingEnvironment (new)
Description :  Description for Disables the specific rule for a web site permanently.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}/disable
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
environmentName:
{
Description: Site name ,
Required: True ,
}
string ,
name:
{
Description: Rule name ,
Required: True ,
}
string ,
hostingEnvironmentName:
{
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 ,
}
,
}
Recommendations_ListHistoryForWebApp (new)
Description :  Description for Get past recommendations for an app, optionally specified by the time range.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Name of the app. ,
Required: True ,
}
string ,
expiredOnly:
{
Description: Specify false to return all recommendations. The default is true, which returns only expired recommendations. ,
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 ,
$filter:
{
Description: Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D] ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
categoryTags:
{
Description: The list of category tags that this recommendation belongs to. ,
Required: False ,
}
[
string ,
]
,
actionName:
{
Description: Name of action recommended by this object. ,
Required: False ,
}
string ,
enabled:
{
Description: True if this recommendation is still valid (i.e. "actionable"). False if it is invalid. ,
Format: int32 ,
Required: False ,
}
integer ,
states:
{
Description: The list of states of this recommendation. If it's null then it should be considered "Active". ,
Required: False ,
}
[
string ,
]
,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
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 ,
}
,
}
Recommendations_ListRecommendedRulesForWebApp (new)
Description :  Description for Get all recommendations for an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Name of the app. ,
Required: True ,
}
string ,
featured:
{
Description: Specify true to return only the most critical recommendations. The default is false, which returns all recommendations. ,
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 ,
$filter:
{
Description: Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
categoryTags:
{
Description: The list of category tags that this recommendation belongs to. ,
Required: False ,
}
[
string ,
]
,
actionName:
{
Description: Name of action recommended by this object. ,
Required: False ,
}
string ,
enabled:
{
Description: True if this recommendation is still valid (i.e. "actionable"). False if it is invalid. ,
Format: int32 ,
Required: False ,
}
integer ,
states:
{
Description: The list of states of this recommendation. If it's null then it should be considered "Active". ,
Required: False ,
}
[
string ,
]
,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
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 ,
}
,
}
Recommendations_DisableAllForWebApp (new)
Description :  Description for Disable all recommendations for an app.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Recommendations_ResetAllFiltersForWebApp (new)
Description :  Description for Reset all recommendation opt-out settings for an app.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Recommendations_GetRuleDetailsByWebApp (new)
Description :  Description for Get a recommendation rule for an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Name of the app. ,
Required: True ,
}
string ,
name:
{
Description: Name of the recommendation. ,
Required: True ,
}
string ,
updateSeen:
{
Description: Specify true to update the last-seen timestamp of the recommendation object. ,
Required: False ,
}
boolean ,
recommendationId:
{
Description: The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry. ,
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: RecommendationRule resource specific properties ,
Required: False ,
}
{
recommendationName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule. ,
Required: False ,
}
string ,
message:
{
Description: Localized name of the rule (Good for UI). ,
Required: False ,
}
string ,
recommendationId:
{
Description: Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn't exist, it is set to null. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: Localized detailed description of the rule. ,
Required: False ,
}
string ,
actionName:
{
Description: Name of action that is recommended by this rule in string. ,
Required: False ,
}
string ,
level:
{
Description: Level of impact indicating how critical this rule is. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of available channels that this rule applies. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
categoryTags:
{
Description: The list of category tags that this recommendation rule belongs to. ,
Required: False ,
}
[
string ,
]
,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. Applicable to dynamic rule only. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. Applicable to dynamic rule only. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. Applicable to dynamic rule only. ,
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 ,
}
,
}
Recommendations_DisableRecommendationForSite (new)
Description :  Description for Disables the specific rule for a web site permanently.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}/disable
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
name:
{
Description: Rule name ,
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 ,
}
,
}
ResourceHealthMetadata_List (new)
Description :  Description for List all ResourceHealthMetadata for all sites in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/resourceHealthMetadata
{
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: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
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 ,
}
,
}
ResourceHealthMetadata_ListByResourceGroup (new)
Description :  Description for List all ResourceHealthMetadata for all sites in the resource group in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/resourceHealthMetadata
{
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: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
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 ,
}
,
}
ResourceHealthMetadata_ListBySite (new)
Description :  Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
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 ,
}
,
}
ResourceHealthMetadata_GetBySite (new)
Description :  Description for Gets the category of ResourceHealthMetadata to use for the given site
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata/default
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
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: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
ResourceHealthMetadata_ListBySiteSlot (new)
Description :  Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
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 ,
}
,
}
ResourceHealthMetadata_GetBySiteSlot (new)
Description :  Description for Gets the category of ResourceHealthMetadata to use for the given site
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata/default
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
GetPublishingUser (new)
Description :  Description for Gets publishing user
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Web/publishingUsers/web
{
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: User resource specific properties ,
Required: False ,
}
{
publishingUserName:
{
Description: Username used for publishing. ,
Required: True ,
}
string ,
publishingPassword:
{
Description: Password used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHash:
{
Description: Password hash used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHashSalt:
{
Description: Password hash salt used for publishing. ,
Format: password ,
Required: False ,
}
string ,
scmUri:
{
Description: Url of SCM site. ,
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 ,
}
,
}
UpdatePublishingUser (new)
Description :  Description for Updates publishing user
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Web/publishingUsers/web
{
userDetails:
{
Description: Details of publishing user ,
Required: True ,
}
{
properties:
{
Description: User resource specific properties ,
Required: False ,
}
{
publishingUserName:
{
Description: Username used for publishing. ,
Required: True ,
}
string ,
publishingPassword:
{
Description: Password used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHash:
{
Description: Password hash used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHashSalt:
{
Description: Password hash salt used for publishing. ,
Format: password ,
Required: False ,
}
string ,
scmUri:
{
Description: Url of SCM site. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: User resource specific properties ,
Required: False ,
}
{
publishingUserName:
{
Description: Username used for publishing. ,
Required: True ,
}
string ,
publishingPassword:
{
Description: Password used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHash:
{
Description: Password hash used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHashSalt:
{
Description: Password hash salt used for publishing. ,
Format: password ,
Required: False ,
}
string ,
scmUri:
{
Description: Url of SCM site. ,
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 ,
}
,
}
ListSourceControls (new)
Description :  Description for Gets the source controls available for Azure websites.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Web/sourcecontrols
{
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: SourceControl resource specific properties ,
Required: False ,
}
{
token:
{
Description: OAuth access token. ,
Required: False ,
}
string ,
tokenSecret:
{
Description: OAuth access token secret. ,
Required: False ,
}
string ,
refreshToken:
{
Description: OAuth refresh token. ,
Required: False ,
}
string ,
expirationTime:
{
Description: OAuth token expiration. ,
Format: date-time ,
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 ,
}
,
}
GetSourceControl (new)
Description :  Description for Gets source control token
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Web/sourcecontrols/{sourceControlType}
{
sourceControlType:
{
Description: Type of source control ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SourceControl resource specific properties ,
Required: False ,
}
{
token:
{
Description: OAuth access token. ,
Required: False ,
}
string ,
tokenSecret:
{
Description: OAuth access token secret. ,
Required: False ,
}
string ,
refreshToken:
{
Description: OAuth refresh token. ,
Required: False ,
}
string ,
expirationTime:
{
Description: OAuth token expiration. ,
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 ,
}
,
}
UpdateSourceControl (new)
Description :  Description for Updates source control token
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Web/sourcecontrols/{sourceControlType}
{
sourceControlType:
{
Description: Type of source control ,
Required: True ,
}
string ,
requestMessage:
{
Description: Source control token information ,
Required: True ,
}
{
properties:
{
Description: SourceControl resource specific properties ,
Required: False ,
}
{
token:
{
Description: OAuth access token. ,
Required: False ,
}
string ,
tokenSecret:
{
Description: OAuth access token secret. ,
Required: False ,
}
string ,
refreshToken:
{
Description: OAuth refresh token. ,
Required: False ,
}
string ,
expirationTime:
{
Description: OAuth token expiration. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SourceControl resource specific properties ,
Required: False ,
}
{
token:
{
Description: OAuth access token. ,
Required: False ,
}
string ,
tokenSecret:
{
Description: OAuth access token secret. ,
Required: False ,
}
string ,
refreshToken:
{
Description: OAuth refresh token. ,
Required: False ,
}
string ,
expirationTime:
{
Description: OAuth token expiration. ,
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 ,
}
,
}
ListBillingMeters (new)
Description :  Description for Gets a list of meters for a given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters
{
billingLocation:
{
Description: Azure Location of billable resource ,
Required: False ,
}
string ,
osType:
{
Description: App Service OS type meters used for ,
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: BillingMeter resource specific properties ,
Required: False ,
}
{
meterId:
{
Description: Meter GUID onboarded in Commerce ,
Required: False ,
}
string ,
billingLocation:
{
Description: Azure Location of billable resource ,
Required: False ,
}
string ,
shortName:
{
Description: Short Name from App Service Azure pricing Page ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the meter ,
Required: False ,
}
string ,
resourceType:
{
Description: App Service ResourceType meter used for ,
Required: False ,
}
string ,
osType:
{
Description: App Service OS type meter used for ,
Required: False ,
}
string ,
multiplier:
{
Description: Meter Multiplier ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
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 ,
}
,
}
CheckNameAvailability (new)
Description :  Description for Check if a resource name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability
{
request:
{
Description: Name availability request. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Enum:
{
Site: No description available. ,
Slot: No description available. ,
HostingEnvironment: No description available. ,
PublishingUser: No description available. ,
Microsoft.Web/sites: No description available. ,
Microsoft.Web/sites/slots: No description available. ,
Microsoft.Web/hostingEnvironments: No description available. ,
Microsoft.Web/publishingUsers: No description available. ,
}
,
Required: True ,
}
enum ,
isFqdn:
{
Description: Is fully qualified domain name. ,
Required: False ,
}
boolean ,
environmentId:
{
Description: Azure Resource Manager ID of the customer's selected Container Apps Environment on which to host the Function app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} ,
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)

{
nameAvailable:
{
Description: true indicates name is valid and available. false indicates the name is invalid, unavailable, or both. ,
Required: False ,
}
boolean ,
reason:
{
Description: Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name. ,
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 ,
}
,
}
ListCustomHostNameSites (new)
Description :  Get custom hostnames under this subscription
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: CustomHostnameSites resource specific properties ,
Required: False ,
}
{
customHostname:
{
Required: False ,
}
string ,
region:
{
Required: False ,
}
string ,
siteResourceIds:
{
Required: False ,
}
[
{
properties:
{
Description: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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 ,
}
,
}
GetSubscriptionDeploymentLocations (new)
Description :  Description for Gets list of available geo regions plus ministamps
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/deploymentLocations
{
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)

{
locations:
{
Description: Available regions. ,
Required: False ,
}
[
{
properties:
{
Description: GeoRegion resource specific properties ,
Required: False ,
}
{
description:
{
Description: Region description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for region. ,
Required: False ,
}
string ,
orgDomain:
{
Description: Display name for region. ,
Required: False ,
}
string ,
}
,
}
,
]
,
hostingEnvironments:
{
Description: Available App Service Environments with full descriptions of the environments. ,
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 ,
}
,
]
,
hostingEnvironmentDeploymentInfos:
{
Description: Available App Service Environments with basic information. ,
Required: False ,
}
[
{
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
location:
{
Description: Location of the App Service Environment. ,
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 ,
}
,
}
ListAseRegions (new)
Description :  Description for get a list of available ASE regions and its supported Skus.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/aseRegions
{
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: ASE region resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Display name for region. ,
Required: False ,
}
string ,
standard:
{
Description: Is region standard. ,
Required: False ,
}
boolean ,
dedicatedHost:
{
Description: Dedicated host enabled. ,
Required: False ,
}
boolean ,
zoneRedundant:
{
Description: Zone redundant deployment enabled. ,
Required: False ,
}
boolean ,
availableSku:
{
Description: Available Skus in region. ,
Required: False ,
}
[
string ,
]
,
availableOS:
{
Description: Available OSs in region. ,
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 ,
}
,
}
ListGeoRegions (new)
Description :  Description for Get a list of available geographical regions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions
{
sku:
{
Description: Name of SKU used to filter the regions. ,
Required: False ,
}
string ,
linuxWorkersEnabled:
{
Description: Specify true if you want to filter to only regions that support Linux workers. ,
Required: False ,
}
boolean ,
xenonWorkersEnabled:
{
Description: Specify true if you want to filter to only regions that support Xenon workers. ,
Required: False ,
}
boolean ,
linuxDynamicWorkersEnabled:
{
Description: Specify true if you want to filter to only regions that support Linux Consumption Workers. ,
Required: False ,
}
boolean ,
customModeWorkersEnabled :
{
Description: Specify true if you want to filter to only regions that support App Service Plans with IsCustomMode set to true. ,
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: GeoRegion resource specific properties ,
Required: False ,
}
{
description:
{
Description: Region description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for region. ,
Required: False ,
}
string ,
orgDomain:
{
Description: Display name for region. ,
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 ,
}
,
}
ListSiteIdentifiersAssignedToHostName (new)
Description :  Description for List all apps that are assigned to a hostname.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/listSitesAssignedToHostName
{
nameIdentifier:
{
Description: Hostname information. ,
Required: True ,
}
{
name:
{
Description: Name of the object. ,
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: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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 ,
}
,
}
RegionalCheckNameAvailability (new)
Description :  Check if a resource name is available for DNL sites.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/checknameavailability
{
location:
{
Required: True ,
}
string ,
request:
{
Description: Name availability request. ,
Required: True ,
}
{
resourceGroupName:
{
Description: Resource group name ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Indicates the endpoint name reuse scope.The default value is TenantReuse. Supported values are TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse ,
Required: False ,
}
string ,
name:
{
Description: Resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Enum:
{
Site: No description available. ,
Slot: No description available. ,
HostingEnvironment: No description available. ,
PublishingUser: No description available. ,
Microsoft.Web/sites: No description available. ,
Microsoft.Web/sites/slots: No description available. ,
Microsoft.Web/hostingEnvironments: No description available. ,
Microsoft.Web/publishingUsers: No description available. ,
}
,
Required: True ,
}
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)

{
hostName:
{
Required: False ,
}
string ,
nameAvailable:
{
Description: true indicates name is valid and available. false indicates the name is invalid, unavailable, or both. ,
Required: False ,
}
boolean ,
reason:
{
Description: Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name. ,
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 ,
}
,
}
ListPremierAddOnOffers (new)
Description :  Description for List all premier add-on offers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers
{
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: PremierAddOnOffer resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on offer Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on offer Vendor. ,
Required: False ,
}
string ,
promoCodeRequired:
{
Description: true if promotion code is required; otherwise, false. ,
Required: False ,
}
boolean ,
quota:
{
Description: Premier add on offer Quota. ,
Format: int32 ,
Required: False ,
}
integer ,
webHostingPlanRestrictions:
{
Description: App Service plans this offer is restricted to. ,
Enum:
{
None: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
privacyPolicyUrl:
{
Description: Privacy policy URL. ,
Required: False ,
}
string ,
legalTermsUrl:
{
Description: Legal terms URL. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Marketplace offer. ,
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 ,
}
,
}
ListSkus (new)
Description :  Description for List all SKUs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/skus
{
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)

{
resourceType:
{
Description: Resource type that this SKU applies to. ,
Required: False ,
}
string ,
skus:
{
Description: List of SKUs the subscription is able to use. ,
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: 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 ,
}
,
}
GetUsagesInLocation_list (new)
Description :  List usages in cores for all skus used by a subscription in a given location, for a specific quota type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/usages
{
location:
{
Description: The name of the Azure region. ,
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 ,
}
[
{
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 ,
}
,
}
VerifyHostingEnvironmentVnet (new)
Description :  Description for Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/verifyHostingEnvironmentVnet
{
parameters:
{
Description: VNET information ,
Required: True ,
}
{
properties:
{
Description: VnetParameters resource specific properties ,
Required: False ,
}
{
vnetResourceGroup:
{
Description: The Resource Group of the VNET to be validated ,
Required: False ,
}
string ,
vnetName:
{
Description: The name of the VNET to be validated ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: The subnet name to be validated ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: The ARM Resource ID of the subnet to validate ,
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: VnetValidationFailureDetails resource specific properties ,
Required: False ,
}
{
message:
{
Description: Text describing the validation outcome. ,
Required: False ,
}
string ,
failed:
{
Description: A flag describing whether or not validation failed. ,
Required: False ,
}
boolean ,
failedTests:
{
Description: A list of tests that failed in the validation. ,
Required: False ,
}
[
{
properties:
{
Description: VnetValidationTestFailure resource specific properties ,
Required: False ,
}
{
testName:
{
Description: The name of the test that failed. ,
Required: False ,
}
string ,
details:
{
Description: The details of what caused the failure, e.g. the blocking rule name, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
warnings:
{
Description: A list of warnings generated during validation. ,
Required: False ,
}
[
{
properties:
{
Description: VnetValidationTestFailure resource specific properties ,
Required: False ,
}
{
testName:
{
Description: The name of the test that failed. ,
Required: False ,
}
string ,
details:
{
Description: The details of what caused the failure, e.g. the blocking rule name, etc. ,
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 ,
}
,
}
Move (new)
Description :  Description for Move resources between resource groups.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
moveResourceEnvelope:
{
Description: Object that represents the resource to move. ,
Required: True ,
}
{
targetResourceGroup:
{
Required: False ,
}
string ,
resources:
{
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 (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 ,
}
,
}
Validate (new)
Description :  Description for Validate if a resource can be created.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
validateRequest:
{
Description: Request with the resources to validate. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Enum:
{
ServerFarm: No description available. ,
Site: No description available. ,
Microsoft.Web/hostingEnvironments: No description available. ,
}
,
Required: True ,
}
enum ,
location:
{
Description: Expected location of the resource. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the resource to validate. ,
Required: True ,
}
{
serverFarmId:
{
Description: ARM resource ID of an App Service plan that would host the app. ,
Required: False ,
}
string ,
skuName:
{
Description: Name of the target SKU for the App Service plan. ,
Required: False ,
}
string ,
needLinuxWorkers:
{
Description: true if App Service plan is for Linux workers; otherwise, false. ,
Required: False ,
}
boolean ,
isSpot:
{
Description: true if App Service plan is for Spot instances; otherwise, false. ,
Required: False ,
}
boolean ,
capacity:
{
Description: Target capacity of the App Service plan (number of VMs). ,
Format: int32 ,
Required: False ,
}
integer ,
hostingEnvironment:
{
Description: Name of App Service Environment where app or App Service plan should be created. ,
Required: False ,
}
string ,
isXenon:
{
Description: true if App Service plan is running as a windows container ,
Required: False ,
}
boolean ,
containerRegistryBaseUrl:
{
Description: Base URL of the container registry ,
Required: False ,
}
string ,
containerRegistryUsername:
{
Description: Username for to access the container registry ,
Required: False ,
}
string ,
containerRegistryPassword:
{
Description: Password for to access the container registry ,
Required: False ,
}
string ,
containerImageRepository:
{
Description: Repository name (image name) ,
Required: False ,
}
string ,
containerImageTag:
{
Description: Image tag ,
Required: False ,
}
string ,
containerImagePlatform:
{
Description: Platform (windows or linux) ,
Required: False ,
}
string ,
appServiceEnvironment:
{
Description: App Service Environment 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)

{
status:
{
Description: Result of validation. ,
Required: False ,
}
string ,
error:
{
Description: Error details for the case when validation fails. ,
Required: False ,
}
{
code:
{
Description: Validation error code. ,
Required: False ,
}
string ,
message:
{
Description: Validation error message. ,
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 ,
}
,
}
ValidateMove (new)
Description :  Description for Validate whether a resource can be moved.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
moveResourceEnvelope:
{
Description: Object that represents the resource to move. ,
Required: True ,
}
{
targetResourceGroup:
{
Required: False ,
}
string ,
resources:
{
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 (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 ,
}
,
}
SiteCertificates_List (new)
Description :  Get all certificates in a resource group under a site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/certificates
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
SiteCertificates_Get (new)
Description :  Get a certificate belonging to a given site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/certificates/{certificateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
SiteCertificates_CreateOrUpdate (new)
Description :  Create or update a certificate under a given site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/certificates/{certificateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate, if it exists already. ,
Required: True ,
}
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
SiteCertificates_Delete (new)
Description :  Delete a certificate from the site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/certificates/{certificateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}
,
}
SiteCertificates_Update (new)
Description :  Create or update a certificate under a given site.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/certificates/{certificateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate, if it exists already. ,
Required: True ,
}
{
properties:
{
Description: CertificatePatchResource resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: 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 ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
SiteCertificates_ListSlot (new)
Description :  Get all certificates in a resource group for a given site and a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/certificates
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
SiteCertificates_GetSlot (new)
Description :  Get a certificate for a given site and deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/certificates/{certificateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
SiteCertificates_CreateOrUpdateSlot (new)
Description :  Create or update a certificate in a given site and deployment slot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/certificates/{certificateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate, if it exists already. ,
Required: True ,
}
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
SiteCertificates_DeleteSlot (new)
Description :  Delete a certificate for a given site and deployment slot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/certificates/{certificateName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}
,
}
SiteCertificates_UpdateSlot (new)
Description :  Create or update a certificate for a site and deployment slot.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/certificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate, if it exists already. ,
Required: True ,
}
{
properties:
{
Description: CertificatePatchResource resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: 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 ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
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 ,
}
,
keyVaultId:
{
Description: Azure Key Vault Csm resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Azure Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan. ,
Format: arm-id ,
Required: False ,
}
string ,
canonicalName:
{
Description: CNAME of the certificate to be issued via free certificate ,
Required: False ,
}
string ,
domainValidationMethod:
{
Description: Method of domain validation for free cert ,
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 ,
}
,
}
StaticSites_PreviewWorkflow (new)
Description :  Description for Generates a preview workflow file for the static site
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/previewStaticSiteWorkflowFile
{
location:
{
Description: Location where you plan to create the static site. ,
Required: True ,
}
string ,
staticSitesWorkflowPreviewRequest:
{
Description: A JSON representation of the StaticSitesWorkflowPreviewRequest properties. See example. ,
Required: True ,
}
{
properties:
{
Description: StaticSitesWorkflowPreviewRequest resource specific properties ,
Required: False ,
}
{
repositoryUrl:
{
Description: URL for the repository of the static site. ,
Required: False ,
}
string ,
branch:
{
Description: The target branch in the repository. ,
Required: False ,
}
string ,
buildProperties:
{
Description: Build properties to configure on the repository. ,
Required: False ,
}
{
appLocation:
{
Description: The path to the app code within the repository. ,
Required: False ,
}
string ,
apiLocation:
{
Description: The path to the api code within the repository. ,
Required: False ,
}
string ,
appArtifactLocation:
{
Description: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ,
Required: False ,
}
string ,
outputLocation:
{
Description: The output path of the app after building. ,
Required: False ,
}
string ,
appBuildCommand:
{
Description: A custom command to run during deployment of the static content application. ,
Required: False ,
}
string ,
apiBuildCommand:
{
Description: A custom command to run during deployment of the Azure Functions API application. ,
Required: False ,
}
string ,
skipGithubActionWorkflowGeneration:
{
Description: Skip Github Action workflow generation. ,
Required: False ,
}
boolean ,
githubActionSecretNameOverride:
{
Description: Github Action secret name override. ,
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: StaticSitesWorkflowPreview resource specific properties ,
Required: False ,
}
{
path:
{
Description: The path for the workflow file to be generated ,
Required: False ,
}
string ,
contents:
{
Description: The contents for the workflow file to be generated ,
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 ,
}
,
}
StaticSites_List (new)
Description :  Description for Get all Static Sites for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSites
{
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 ,
}
{
defaultHostname:
{
Description: The default autogenerated hostname for the static site. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: URL for the repository of the static site. ,
Required: False ,
}
string ,
branch:
{
Description: The target branch in the repository. ,
Required: False ,
}
string ,
customDomains:
{
Description: The custom domains associated with this static site. ,
Required: False ,
}
[
string ,
]
,
repositoryToken:
{
Description: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. ,
Required: False ,
}
string ,
buildProperties:
{
Description: Build properties to configure on the repository. ,
Required: False ,
}
{
appLocation:
{
Description: The path to the app code within the repository. ,
Required: False ,
}
string ,
apiLocation:
{
Description: The path to the api code within the repository. ,
Required: False ,
}
string ,
appArtifactLocation:
{
Description: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ,
Required: False ,
}
string ,
outputLocation:
{
Description: The output path of the app after building. ,
Required: False ,
}
string ,
appBuildCommand:
{
Description: A custom command to run during deployment of the static content application. ,
Required: False ,
}
string ,
apiBuildCommand:
{
Description: A custom command to run during deployment of the Azure Functions API application. ,
Required: False ,
}
string ,
skipGithubActionWorkflowGeneration:
{
Description: Skip Github Action workflow generation. ,
Required: False ,
}
boolean ,
githubActionSecretNameOverride:
{
Description: Github Action secret name override. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g "Microsoft.Web/sites". ,
Required: False ,
}
string ,
location:
{
Description: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource. ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher. ,
Required: False ,
}
string ,
product:
{
Description: The product. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: Version of product. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties. ,
Required: False ,
}
{
properties:
{
Description: RemotePrivateEndpointConnection 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 ,
]
,
}
,
}
,
sku:
{
Description: SKU description of the 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 ,
}
,
]
,
}
,
status:
{
Description: Azure-AsyncOperation Status info. ,
Required: False ,
}
string ,
error:
{
Description: Azure-AsyncOperation Error info. ,
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 ,
}
,
identity:
{
Description: MSI resource ,
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 ,
}
,
zones:
{
Description: Logical Availability Zones the service is hosted in ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
stagingEnvironmentPolicy:
{
Description: State indicating whether staging environments are allowed or not allowed for a static web app. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowConfigFileUpdates:
{
Description: false if config file is locked for this static web app; otherwise, true. ,
Required: False ,
}
boolean ,
templateProperties:
{
Description: Template options for generating a new repository. ,
Required: False ,
}
{
templateRepositoryUrl:
{
Description: URL of the template repository. The newly generated repository will be based on this one. ,
Required: False ,
}
string ,
owner:
{
Description: Owner of the newly generated repository. ,
Required: False ,
}
string ,
repositoryName:
{
Description: Name of the newly generated repository. ,
Required: False ,
}
string ,
description:
{
Description: Description of the newly generated repository. ,
Required: False ,
}
string ,
isPrivate:
{
Description: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). ,
Required: False ,
}
boolean ,
}
,
contentDistributionEndpoint:
{
Description: The content distribution endpoint for the static site. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
provider:
{
Description: The provider that submitted the last deployment to the primary environment of the static site. ,
Required: False ,
}
string ,
enterpriseGradeCdnStatus:
{
Description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. ,
Enum:
{
Enabled: No description available. ,
Enabling: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
databaseConnections:
{
Description: Database connections for the static site ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection resource. ,
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 ,
}
,
]
,
}
,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
StaticSites_GetStaticSitesByResourceGroup (new)
Description :  Description for Gets all static sites in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites
{
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 ,
}
{
defaultHostname:
{
Description: The default autogenerated hostname for the static site. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: URL for the repository of the static site. ,
Required: False ,
}
string ,
branch:
{
Description: The target branch in the repository. ,
Required: False ,
}
string ,
customDomains:
{
Description: The custom domains associated with this static site. ,
Required: False ,
}
[
string ,
]
,
repositoryToken:
{
Description: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. ,
Required: False ,
}
string ,
buildProperties:
{
Description: Build properties to configure on the repository. ,
Required: False ,
}
{
appLocation:
{
Description: The path to the app code within the repository. ,
Required: False ,
}
string ,
apiLocation:
{
Description: The path to the api code within the repository. ,
Required: False ,
}
string ,
appArtifactLocation:
{
Description: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ,
Required: False ,
}
string ,
outputLocation:
{
Description: The output path of the app after building. ,
Required: False ,
}
string ,
appBuildCommand:
{
Description: A custom command to run during deployment of the static content application. ,
Required: False ,
}
string ,
apiBuildCommand:
{
Description: A custom command to run during deployment of the Azure Functions API application. ,
Required: False ,
}
string ,
skipGithubActionWorkflowGeneration:
{
Description: Skip Github Action workflow generation. ,
Required: False ,
}
boolean ,
githubActionSecretNameOverride:
{
Description: Github Action secret name override. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g "Microsoft.Web/sites". ,
Required: False ,
}
string ,
location:
{
Description: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource. ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher. ,
Required: False ,
}
string ,
product:
{
Description: The product. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: Version of product. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties. ,
Required: False ,
}
{
properties:
{
Description: RemotePrivateEndpointConnection 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 ,
]
,
}
,
}
,
sku:
{
Description: SKU description of the 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 ,
}
,
]
,
}
,
status:
{
Description: Azure-AsyncOperation Status info. ,
Required: False ,
}
string ,
error:
{
Description: Azure-AsyncOperation Error info. ,
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 ,
}
,
identity:
{
Description: MSI resource ,
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 ,
}
,
zones:
{
Description: Logical Availability Zones the service is hosted in ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
stagingEnvironmentPolicy:
{
Description: State indicating whether staging environments are allowed or not allowed for a static web app. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowConfigFileUpdates:
{
Description: false if config file is locked for this static web app; otherwise, true. ,
Required: False ,
}
boolean ,
templateProperties:
{
Description: Template options for generating a new repository. ,
Required: False ,
}
{
templateRepositoryUrl:
{
Description: URL of the template repository. The newly generated repository will be based on this one. ,
Required: False ,
}
string ,
owner:
{
Description: Owner of the newly generated repository. ,
Required: False ,
}
string ,
repositoryName:
{
Description: Name of the newly generated repository. ,
Required: False ,
}
string ,
description:
{
Description: Description of the newly generated repository. ,
Required: False ,
}
string ,
isPrivate:
{
Description: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). ,
Required: False ,
}
boolean ,
}
,
contentDistributionEndpoint:
{
Description: The content distribution endpoint for the static site. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
provider:
{
Description: The provider that submitted the last deployment to the primary environment of the static site. ,
Required: False ,
}
string ,
enterpriseGradeCdnStatus:
{
Description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. ,
Enum:
{
Enabled: No description available. ,
Enabling: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
databaseConnections:
{
Description: Database connections for the static site ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection resource. ,
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 ,
}
,
]
,
}
,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
StaticSites_GetStaticSite (new)
Description :  Description for Gets the details of a static site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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 ,
}
{
defaultHostname:
{
Description: The default autogenerated hostname for the static site. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: URL for the repository of the static site. ,
Required: False ,
}
string ,
branch:
{
Description: The target branch in the repository. ,
Required: False ,
}
string ,
customDomains:
{
Description: The custom domains associated with this static site. ,
Required: False ,
}
[
string ,
]
,
repositoryToken:
{
Description: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. ,
Required: False ,
}
string ,
buildProperties:
{
Description: Build properties to configure on the repository. ,
Required: False ,
}
{
appLocation:
{
Description: The path to the app code within the repository. ,
Required: False ,
}
string ,
apiLocation:
{
Description: The path to the api code within the repository. ,
Required: False ,
}
string ,
appArtifactLocation:
{
Description: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ,
Required: False ,
}
string ,
outputLocation:
{
Description: The output path of the app after building. ,
Required: False ,
}
string ,
appBuildCommand:
{
Description: A custom command to run during deployment of the static content application. ,
Required: False ,
}
string ,
apiBuildCommand:
{
Description: A custom command to run during deployment of the Azure Functions API application. ,
Required: False ,
}
string ,
skipGithubActionWorkflowGeneration:
{
Description: Skip Github Action workflow generation. ,
Required: False ,
}
boolean ,
githubActionSecretNameOverride:
{
Description: Github Action secret name override. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g "Microsoft.Web/sites". ,
Required: False ,
}
string ,
location:
{
Description: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource. ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher. ,
Required: False ,
}
string ,
product:
{
Description: The product. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: Version of product. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties. ,
Required: False ,
}
{
properties:
{
Description: RemotePrivateEndpointConnection 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 ,
]
,
}
,
}
,
sku:
{
Description: SKU description of the 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 ,
}
,
]
,
}
,
status:
{
Description: Azure-AsyncOperation Status info. ,
Required: False ,
}
string ,
error:
{
Description: Azure-AsyncOperation Error info. ,
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 ,
}
,
identity:
{
Description: MSI resource ,
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 ,
}
,
zones:
{
Description: Logical Availability Zones the service is hosted in ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
stagingEnvironmentPolicy:
{
Description: State indicating whether staging environments are allowed or not allowed for a static web app. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowConfigFileUpdates:
{
Description: false if config file is locked for this static web app; otherwise, true. ,
Required: False ,
}
boolean ,
templateProperties:
{
Description: Template options for generating a new repository. ,
Required: False ,
}
{
templateRepositoryUrl:
{
Description: URL of the template repository. The newly generated repository will be based on this one. ,
Required: False ,
}
string ,
owner:
{
Description: Owner of the newly generated repository. ,
Required: False ,
}
string ,
repositoryName:
{
Description: Name of the newly generated repository. ,
Required: False ,
}
string ,
description:
{
Description: Description of the newly generated repository. ,
Required: False ,
}
string ,
isPrivate:
{
Description: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). ,
Required: False ,
}
boolean ,
}
,
contentDistributionEndpoint:
{
Description: The content distribution endpoint for the static site. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
provider:
{
Description: The provider that submitted the last deployment to the primary environment of the static site. ,
Required: False ,
}
string ,
enterpriseGradeCdnStatus:
{
Description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. ,
Enum:
{
Enabled: No description available. ,
Enabling: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
databaseConnections:
{
Description: Database connections for the static site ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection resource. ,
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 ,
}
,
]
,
}
,
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 ,
}
,
}

⚐ 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 ,
}
,
}
StaticSites_CreateOrUpdateStaticSite (new)
Description :  Description for Creates a new static site in an existing resource group, or updates an existing static site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site to create or update. ,
Required: True ,
}
string ,
staticSiteEnvelope:
{
Description: A JSON representation of the staticsite properties. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
defaultHostname:
{
Description: The default autogenerated hostname for the static site. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: URL for the repository of the static site. ,
Required: False ,
}
string ,
branch:
{
Description: The target branch in the repository. ,
Required: False ,
}
string ,
customDomains:
{
Description: The custom domains associated with this static site. ,
Required: False ,
}
[
string ,
]
,
repositoryToken:
{
Description: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. ,
Required: False ,
}
string ,
buildProperties:
{
Description: Build properties to configure on the repository. ,
Required: False ,
}
{
appLocation:
{
Description: The path to the app code within the repository. ,
Required: False ,
}
string ,
apiLocation:
{
Description: The path to the api code within the repository. ,
Required: False ,
}
string ,
appArtifactLocation:
{
Description: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ,
Required: False ,
}
string ,
outputLocation:
{
Description: The output path of the app after building. ,
Required: False ,
}
string ,
appBuildCommand:
{
Description: A custom command to run during deployment of the static content application. ,
Required: False ,
}
string ,
apiBuildCommand:
{
Description: A custom command to run during deployment of the Azure Functions API application. ,
Required: False ,
}
string ,
skipGithubActionWorkflowGeneration:
{
Description: Skip Github Action workflow generation. ,
Required: False ,
}
boolean ,
githubActionSecretNameOverride:
{
Description: Github Action secret name override. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g "Microsoft.Web/sites". ,
Required: False ,
}
string ,
location:
{
Description: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource. ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher. ,
Required: False ,
}
string ,
product:
{
Description: The product. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: Version of product. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties. ,
Required: False ,
}
{
properties:
{
Description: RemotePrivateEndpointConnection 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 ,
]
,
}
,
}
,
sku:
{
Description: SKU description of the 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 ,
}
,
]
,
}
,
status:
{
Description: Azure-AsyncOperation Status info. ,
Required: False ,
}
string ,
error:
{
Description: Azure-AsyncOperation Error info. ,
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 ,
}
,
identity:
{
Description: MSI resource ,
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 ,
}
,
zones:
{
Description: Logical Availability Zones the service is hosted in ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
stagingEnvironmentPolicy:
{
Description: State indicating whether staging environments are allowed or not allowed for a static web app. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowConfigFileUpdates:
{
Description: false if config file is locked for this static web app; otherwise, true. ,
Required: False ,
}
boolean ,
templateProperties:
{
Description: Template options for generating a new repository. ,
Required: False ,
}
{
templateRepositoryUrl:
{
Description: URL of the template repository. The newly generated repository will be based on this one. ,
Required: False ,
}
string ,
owner:
{
Description: Owner of the newly generated repository. ,
Required: False ,
}
string ,
repositoryName:
{
Description: Name of the newly generated repository. ,
Required: False ,
}
string ,
description:
{
Description: Description of the newly generated repository. ,
Required: False ,
}
string ,
isPrivate:
{
Description: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). ,
Required: False ,
}
boolean ,
}
,
contentDistributionEndpoint:
{
Description: The content distribution endpoint for the static site. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
provider:
{
Description: The provider that submitted the last deployment to the primary environment of the static site. ,
Required: False ,
}
string ,
enterpriseGradeCdnStatus:
{
Description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. ,
Enum:
{
Enabled: No description available. ,
Enabling: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
databaseConnections:
{
Description: Database connections for the static site ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection resource. ,
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 ,
}
,
]
,
}
,
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: Core resource properties ,
Required: False ,
}
{
defaultHostname:
{
Description: The default autogenerated hostname for the static site. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: URL for the repository of the static site. ,
Required: False ,
}
string ,
branch:
{
Description: The target branch in the repository. ,
Required: False ,
}
string ,
customDomains:
{
Description: The custom domains associated with this static site. ,
Required: False ,
}
[
string ,
]
,
repositoryToken:
{
Description: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. ,
Required: False ,
}
string ,
buildProperties:
{
Description: Build properties to configure on the repository. ,
Required: False ,
}
{
appLocation:
{
Description: The path to the app code within the repository. ,
Required: False ,
}
string ,
apiLocation:
{
Description: The path to the api code within the repository. ,
Required: False ,
}
string ,
appArtifactLocation:
{
Description: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ,
Required: False ,
}
string ,
outputLocation:
{
Description: The output path of the app after building. ,
Required: False ,
}
string ,
appBuildCommand:
{
Description: A custom command to run during deployment of the static content application. ,
Required: False ,
}
string ,
apiBuildCommand:
{
Description: A custom command to run during deployment of the Azure Functions API application. ,
Required: False ,
}
string ,
skipGithubActionWorkflowGeneration:
{
Description: Skip Github Action workflow generation. ,
Required: False ,
}
boolean ,
githubActionSecretNameOverride:
{
Description: Github Action secret name override. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g "Microsoft.Web/sites". ,
Required: False ,
}
string ,
location:
{
Description: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource. ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher. ,
Required: False ,
}
string ,
product:
{
Description: The product. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: Version of product. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties. ,
Required: False ,
}
{
properties:
{
Description: RemotePrivateEndpointConnection 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 ,
]
,
}
,
}
,
sku:
{
Description: SKU description of the 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 ,
}
,
]
,
}
,
status:
{
Description: Azure-AsyncOperation Status info. ,
Required: False ,
}
string ,
error:
{
Description: Azure-AsyncOperation Error info. ,
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 ,
}
,
identity:
{
Description: MSI resource ,
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 ,
}
,
zones:
{
Description: Logical Availability Zones the service is hosted in ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
stagingEnvironmentPolicy:
{
Description: State indicating whether staging environments are allowed or not allowed for a static web app. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowConfigFileUpdates:
{
Description: false if config file is locked for this static web app; otherwise, true. ,
Required: False ,
}
boolean ,
templateProperties:
{
Description: Template options for generating a new repository. ,
Required: False ,
}
{
templateRepositoryUrl:
{
Description: URL of the template repository. The newly generated repository will be based on this one. ,
Required: False ,
}
string ,
owner:
{
Description: Owner of the newly generated repository. ,
Required: False ,
}
string ,
repositoryName:
{
Description: Name of the newly generated repository. ,
Required: False ,
}
string ,
description:
{
Description: Description of the newly generated repository. ,
Required: False ,
}
string ,
isPrivate:
{
Description: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). ,
Required: False ,
}
boolean ,
}
,
contentDistributionEndpoint:
{
Description: The content distribution endpoint for the static site. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
provider:
{
Description: The provider that submitted the last deployment to the primary environment of the static site. ,
Required: False ,
}
string ,
enterpriseGradeCdnStatus:
{
Description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. ,
Enum:
{
Enabled: No description available. ,
Enabling: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
databaseConnections:
{
Description: Database connections for the static site ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection resource. ,
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 ,
}
,
]
,
}
,
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 ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
defaultHostname:
{
Description: The default autogenerated hostname for the static site. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: URL for the repository of the static site. ,
Required: False ,
}
string ,
branch:
{
Description: The target branch in the repository. ,
Required: False ,
}
string ,
customDomains:
{
Description: The custom domains associated with this static site. ,
Required: False ,
}
[
string ,
]
,
repositoryToken:
{
Description: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. ,
Required: False ,
}
string ,
buildProperties:
{
Description: Build properties to configure on the repository. ,
Required: False ,
}
{
appLocation:
{
Description: The path to the app code within the repository. ,
Required: False ,
}
string ,
apiLocation:
{
Description: The path to the api code within the repository. ,
Required: False ,
}
string ,
appArtifactLocation:
{
Description: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ,
Required: False ,
}
string ,
outputLocation:
{
Description: The output path of the app after building. ,
Required: False ,
}
string ,
appBuildCommand:
{
Description: A custom command to run during deployment of the static content application. ,
Required: False ,
}
string ,
apiBuildCommand:
{
Description: A custom command to run during deployment of the Azure Functions API application. ,
Required: False ,
}
string ,
skipGithubActionWorkflowGeneration:
{
Description: Skip Github Action workflow generation. ,
Required: False ,
}
boolean ,
githubActionSecretNameOverride:
{
Description: Github Action secret name override. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g "Microsoft.Web/sites". ,
Required: False ,
}
string ,
location:
{
Description: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource. ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher. ,
Required: False ,
}
string ,
product:
{
Description: The product. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: Version of product. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties. ,
Required: False ,
}
{
properties:
{
Description: RemotePrivateEndpointConnection 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 ,
]
,
}
,
}
,
sku:
{
Description: SKU description of the 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 ,
}
,
]
,
}
,
status:
{
Description: Azure-AsyncOperation Status info. ,
Required: False ,
}
string ,
error:
{
Description: Azure-AsyncOperation Error info. ,
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 ,
}
,
identity:
{
Description: MSI resource ,
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 ,
}
,
zones:
{
Description: Logical Availability Zones the service is hosted in ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
stagingEnvironmentPolicy:
{
Description: State indicating whether staging environments are allowed or not allowed for a static web app. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowConfigFileUpdates:
{
Description: false if config file is locked for this static web app; otherwise, true. ,
Required: False ,
}
boolean ,
templateProperties:
{
Description: Template options for generating a new repository. ,
Required: False ,
}
{
templateRepositoryUrl:
{
Description: URL of the template repository. The newly generated repository will be based on this one. ,
Required: False ,
}
string ,
owner:
{
Description: Owner of the newly generated repository. ,
Required: False ,
}
string ,
repositoryName:
{
Description: Name of the newly generated repository. ,
Required: False ,
}
string ,
description:
{
Description: Description of the newly generated repository. ,
Required: False ,
}
string ,
isPrivate:
{
Description: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). ,
Required: False ,
}
boolean ,
}
,
contentDistributionEndpoint:
{
Description: The content distribution endpoint for the static site. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
provider:
{
Description: The provider that submitted the last deployment to the primary environment of the static site. ,
Required: False ,
}
string ,
enterpriseGradeCdnStatus:
{
Description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. ,
Enum:
{
Enabled: No description available. ,
Enabling: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
databaseConnections:
{
Description: Database connections for the static site ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection resource. ,
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 ,
}
,
]
,
}
,
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 ,
}
,
}

⚐ 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 ,
}
,
}
StaticSites_DeleteStaticSite (new)
Description :  Description for Deletes a static site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site to delete. ,
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 (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 ,
}
,
}
StaticSites_UpdateStaticSite (new)
Description :  Description for Creates a new static site in an existing resource group, or updates an existing static site.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site to create or update. ,
Required: True ,
}
string ,
staticSiteEnvelope:
{
Description: A JSON representation of the staticsite properties. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
defaultHostname:
{
Description: The default autogenerated hostname for the static site. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: URL for the repository of the static site. ,
Required: False ,
}
string ,
branch:
{
Description: The target branch in the repository. ,
Required: False ,
}
string ,
customDomains:
{
Description: The custom domains associated with this static site. ,
Required: False ,
}
[
string ,
]
,
repositoryToken:
{
Description: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. ,
Required: False ,
}
string ,
buildProperties:
{
Description: Build properties to configure on the repository. ,
Required: False ,
}
{
appLocation:
{
Description: The path to the app code within the repository. ,
Required: False ,
}
string ,
apiLocation:
{
Description: The path to the api code within the repository. ,
Required: False ,
}
string ,
appArtifactLocation:
{
Description: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ,
Required: False ,
}
string ,
outputLocation:
{
Description: The output path of the app after building. ,
Required: False ,
}
string ,
appBuildCommand:
{
Description: A custom command to run during deployment of the static content application. ,
Required: False ,
}
string ,
apiBuildCommand:
{
Description: A custom command to run during deployment of the Azure Functions API application. ,
Required: False ,
}
string ,
skipGithubActionWorkflowGeneration:
{
Description: Skip Github Action workflow generation. ,
Required: False ,
}
boolean ,
githubActionSecretNameOverride:
{
Description: Github Action secret name override. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g "Microsoft.Web/sites". ,
Required: False ,
}
string ,
location:
{
Description: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource. ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher. ,
Required: False ,
}
string ,
product:
{
Description: The product. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: Version of product. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties. ,
Required: False ,
}
{
properties:
{
Description: RemotePrivateEndpointConnection 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 ,
]
,
}
,
}
,
sku:
{
Description: SKU description of the 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 ,
}
,
]
,
}
,
status:
{
Description: Azure-AsyncOperation Status info. ,
Required: False ,
}
string ,
error:
{
Description: Azure-AsyncOperation Error info. ,
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 ,
}
,
identity:
{
Description: MSI resource ,
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 ,
}
,
zones:
{
Description: Logical Availability Zones the service is hosted in ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
stagingEnvironmentPolicy:
{
Description: State indicating whether staging environments are allowed or not allowed for a static web app. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowConfigFileUpdates:
{
Description: false if config file is locked for this static web app; otherwise, true. ,
Required: False ,
}
boolean ,
templateProperties:
{
Description: Template options for generating a new repository. ,
Required: False ,
}
{
templateRepositoryUrl:
{
Description: URL of the template repository. The newly generated repository will be based on this one. ,
Required: False ,
}
string ,
owner:
{
Description: Owner of the newly generated repository. ,
Required: False ,
}
string ,
repositoryName:
{
Description: Name of the newly generated repository. ,
Required: False ,
}
string ,
description:
{
Description: Description of the newly generated repository. ,
Required: False ,
}
string ,
isPrivate:
{
Description: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). ,
Required: False ,
}
boolean ,
}
,
contentDistributionEndpoint:
{
Description: The content distribution endpoint for the static site. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
provider:
{
Description: The provider that submitted the last deployment to the primary environment of the static site. ,
Required: False ,
}
string ,
enterpriseGradeCdnStatus:
{
Description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. ,
Enum:
{
Enabled: No description available. ,
Enabling: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
databaseConnections:
{
Description: Database connections for the static site ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection resource. ,
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 ,
}
{
defaultHostname:
{
Description: The default autogenerated hostname for the static site. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: URL for the repository of the static site. ,
Required: False ,
}
string ,
branch:
{
Description: The target branch in the repository. ,
Required: False ,
}
string ,
customDomains:
{
Description: The custom domains associated with this static site. ,
Required: False ,
}
[
string ,
]
,
repositoryToken:
{
Description: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. ,
Required: False ,
}
string ,
buildProperties:
{
Description: Build properties to configure on the repository. ,
Required: False ,
}
{
appLocation:
{
Description: The path to the app code within the repository. ,
Required: False ,
}
string ,
apiLocation:
{
Description: The path to the api code within the repository. ,
Required: False ,
}
string ,
appArtifactLocation:
{
Description: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ,
Required: False ,
}
string ,
outputLocation:
{
Description: The output path of the app after building. ,
Required: False ,
}
string ,
appBuildCommand:
{
Description: A custom command to run during deployment of the static content application. ,
Required: False ,
}
string ,
apiBuildCommand:
{
Description: A custom command to run during deployment of the Azure Functions API application. ,
Required: False ,
}
string ,
skipGithubActionWorkflowGeneration:
{
Description: Skip Github Action workflow generation. ,
Required: False ,
}
boolean ,
githubActionSecretNameOverride:
{
Description: Github Action secret name override. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g "Microsoft.Web/sites". ,
Required: False ,
}
string ,
location:
{
Description: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource. ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher. ,
Required: False ,
}
string ,
product:
{
Description: The product. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: Version of product. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties. ,
Required: False ,
}
{
properties:
{
Description: RemotePrivateEndpointConnection 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 ,
]
,
}
,
}
,
sku:
{
Description: SKU description of the 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 ,
}
,
]
,
}
,
status:
{
Description: Azure-AsyncOperation Status info. ,
Required: False ,
}
string ,
error:
{
Description: Azure-AsyncOperation Error info. ,
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 ,
}
,
identity:
{
Description: MSI resource ,
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 ,
}
,
zones:
{
Description: Logical Availability Zones the service is hosted in ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
stagingEnvironmentPolicy:
{
Description: State indicating whether staging environments are allowed or not allowed for a static web app. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowConfigFileUpdates:
{
Description: false if config file is locked for this static web app; otherwise, true. ,
Required: False ,
}
boolean ,
templateProperties:
{
Description: Template options for generating a new repository. ,
Required: False ,
}
{
templateRepositoryUrl:
{
Description: URL of the template repository. The newly generated repository will be based on this one. ,
Required: False ,
}
string ,
owner:
{
Description: Owner of the newly generated repository. ,
Required: False ,
}
string ,
repositoryName:
{
Description: Name of the newly generated repository. ,
Required: False ,
}
string ,
description:
{
Description: Description of the newly generated repository. ,
Required: False ,
}
string ,
isPrivate:
{
Description: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). ,
Required: False ,
}
boolean ,
}
,
contentDistributionEndpoint:
{
Description: The content distribution endpoint for the static site. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
provider:
{
Description: The provider that submitted the last deployment to the primary environment of the static site. ,
Required: False ,
}
string ,
enterpriseGradeCdnStatus:
{
Description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. ,
Enum:
{
Enabled: No description available. ,
Enabling: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
databaseConnections:
{
Description: Database connections for the static site ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection resource. ,
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 ,
}
,
]
,
}
,
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 ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
defaultHostname:
{
Description: The default autogenerated hostname for the static site. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: URL for the repository of the static site. ,
Required: False ,
}
string ,
branch:
{
Description: The target branch in the repository. ,
Required: False ,
}
string ,
customDomains:
{
Description: The custom domains associated with this static site. ,
Required: False ,
}
[
string ,
]
,
repositoryToken:
{
Description: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. ,
Required: False ,
}
string ,
buildProperties:
{
Description: Build properties to configure on the repository. ,
Required: False ,
}
{
appLocation:
{
Description: The path to the app code within the repository. ,
Required: False ,
}
string ,
apiLocation:
{
Description: The path to the api code within the repository. ,
Required: False ,
}
string ,
appArtifactLocation:
{
Description: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) ,
Required: False ,
}
string ,
outputLocation:
{
Description: The output path of the app after building. ,
Required: False ,
}
string ,
appBuildCommand:
{
Description: A custom command to run during deployment of the static content application. ,
Required: False ,
}
string ,
apiBuildCommand:
{
Description: A custom command to run during deployment of the Azure Functions API application. ,
Required: False ,
}
string ,
skipGithubActionWorkflowGeneration:
{
Description: Skip Github Action workflow generation. ,
Required: False ,
}
boolean ,
githubActionSecretNameOverride:
{
Description: Github Action secret name override. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g "Microsoft.Web/sites". ,
Required: False ,
}
string ,
location:
{
Description: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource. ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher. ,
Required: False ,
}
string ,
product:
{
Description: The product. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: Version of product. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties. ,
Required: False ,
}
{
properties:
{
Description: RemotePrivateEndpointConnection 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 ,
]
,
}
,
}
,
sku:
{
Description: SKU description of the 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 ,
}
,
]
,
}
,
status:
{
Description: Azure-AsyncOperation Status info. ,
Required: False ,
}
string ,
error:
{
Description: Azure-AsyncOperation Error info. ,
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 ,
}
,
identity:
{
Description: MSI resource ,
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 ,
}
,
zones:
{
Description: Logical Availability Zones the service is hosted in ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
stagingEnvironmentPolicy:
{
Description: State indicating whether staging environments are allowed or not allowed for a static web app. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowConfigFileUpdates:
{
Description: false if config file is locked for this static web app; otherwise, true. ,
Required: False ,
}
boolean ,
templateProperties:
{
Description: Template options for generating a new repository. ,
Required: False ,
}
{
templateRepositoryUrl:
{
Description: URL of the template repository. The newly generated repository will be based on this one. ,
Required: False ,
}
string ,
owner:
{
Description: Owner of the newly generated repository. ,
Required: False ,
}
string ,
repositoryName:
{
Description: Name of the newly generated repository. ,
Required: False ,
}
string ,
description:
{
Description: Description of the newly generated repository. ,
Required: False ,
}
string ,
isPrivate:
{
Description: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). ,
Required: False ,
}
boolean ,
}
,
contentDistributionEndpoint:
{
Description: The content distribution endpoint for the static site. ,
Required: False ,
}
string ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
provider:
{
Description: The provider that submitted the last deployment to the primary environment of the static site. ,
Required: False ,
}
string ,
enterpriseGradeCdnStatus:
{
Description: State indicating the status of the enterprise grade CDN serving traffic to the static web app. ,
Enum:
{
Enabled: No description available. ,
Enabling: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
databaseConnections:
{
Description: Database connections for the static site ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection resource. ,
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 ,
}
,
]
,
}
,
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 ,
}
,
}

⚐ 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 ,
}
,
}
StaticSites_ListStaticSiteUsers (new)
Description :  Description for Gets the list of users of a static site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/listUsers
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
authprovider:
{
Description: The auth provider for the users. ,
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: StaticSiteUserARMResource resource specific properties ,
Required: False ,
}
{
provider:
{
Description: The identity provider for the static site user. ,
Required: False ,
}
string ,
userId:
{
Description: The user id for the static site user. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the static site user. ,
Required: False ,
}
string ,
roles:
{
Description: The roles for the static site user, in free-form string format ,
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 ,
}
,
}
StaticSites_DeleteStaticSiteUser (new)
Description :  Description for Deletes the user entry from the static site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/users/{userid}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the staticsite. ,
Required: True ,
}
string ,
authprovider:
{
Description: The auth provider for this user. ,
Required: True ,
}
string ,
userid:
{
Description: The user id of the user. ,
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 ,
}
,
}
StaticSites_UpdateStaticSiteUser (new)
Description :  Description for Updates a user entry with the listed roles
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/users/{userid}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
authprovider:
{
Description: The auth provider for this user. ,
Required: True ,
}
string ,
userid:
{
Description: The user id of the user. ,
Required: True ,
}
string ,
staticSiteUserEnvelope:
{
Description: A JSON representation of the StaticSiteUser properties. See example. ,
Required: True ,
}
{
properties:
{
Description: StaticSiteUserARMResource resource specific properties ,
Required: False ,
}
{
provider:
{
Description: The identity provider for the static site user. ,
Required: False ,
}
string ,
userId:
{
Description: The user id for the static site user. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the static site user. ,
Required: False ,
}
string ,
roles:
{
Description: The roles for the static site user, in free-form string format ,
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: StaticSiteUserARMResource resource specific properties ,
Required: False ,
}
{
provider:
{
Description: The identity provider for the static site user. ,
Required: False ,
}
string ,
userId:
{
Description: The user id for the static site user. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the static site user. ,
Required: False ,
}
string ,
roles:
{
Description: The roles for the static site user, in free-form string format ,
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 ,
}
,
}
StaticSites_GetStaticSiteBuilds (new)
Description :  Description for Gets all static site builds for a particular static site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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: StaticSiteBuildARMResource resource specific properties ,
Required: False ,
}
{
buildId:
{
Description: An identifier for the static site build. ,
Required: False ,
}
string ,
sourceBranch:
{
Description: The source branch. ,
Required: False ,
}
string ,
pullRequestTitle:
{
Description: The title of a pull request that a static site build is related to. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for a static site build. ,
Required: False ,
}
string ,
createdTimeUtc:
{
Description: When this build was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: When this build was updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the static site build. ,
Enum:
{
WaitingForDeployment: No description available. ,
Uploading: No description available. ,
Deploying: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Detached: No description available. ,
}
,
Required: False ,
}
enum ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site build ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side build ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
databaseConnections:
{
Description: Database connections for the static site build ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection resource. ,
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 ,
}
,
}
StaticSites_GetStaticSiteBuild (new)
Description :  Description for Gets the details of a static site build.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
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: StaticSiteBuildARMResource resource specific properties ,
Required: False ,
}
{
buildId:
{
Description: An identifier for the static site build. ,
Required: False ,
}
string ,
sourceBranch:
{
Description: The source branch. ,
Required: False ,
}
string ,
pullRequestTitle:
{
Description: The title of a pull request that a static site build is related to. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for a static site build. ,
Required: False ,
}
string ,
createdTimeUtc:
{
Description: When this build was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: When this build was updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the static site build. ,
Enum:
{
WaitingForDeployment: No description available. ,
Uploading: No description available. ,
Deploying: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Detached: No description available. ,
}
,
Required: False ,
}
enum ,
userProvidedFunctionApps:
{
Description: User provided function apps registered with the static site build ,
Required: False ,
}
[
{
properties:
{
Description: StaticSiteUserProvidedFunctionApp resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
linkedBackends:
{
Description: Backends linked to the static side build ,
Required: False ,
}
[
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
Required: False ,
}
string ,
}
,
]
,
databaseConnections:
{
Description: Database connections for the static site build ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: False ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: If present, the name of this database connection 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 ,
}
,
}
StaticSites_DeleteStaticSiteBuild (new)
Description :  Description for Deletes a static site build.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
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 (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 ,
}
,
}
StaticSites_CreateOrUpdateStaticSiteBuildAppSettings (new)
Description :  Description for Creates or updates the app settings of a static site build.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/appsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
Required: True ,
}
string ,
appSettings:
{
Description: The dictionary containing the static site app settings to update. ,
Required: True ,
}
{
properties:
{
Description: Settings. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
StaticSites_CreateOrUpdateStaticSiteBuildFunctionAppSettings (new)
Description :  Description for Creates or updates the function app settings of a static site build.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/functionappsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
Required: True ,
}
string ,
appSettings:
{
Description: The dictionary containing the static site function app settings to update. ,
Required: True ,
}
{
properties:
{
Description: Settings. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
StaticSites_GetBuildDatabaseConnections (new)
Description :  Returns overviews of database connections for a static site build
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_GetBuildDatabaseConnection (new)
Description :  Returns overview of a database connection for a static site build by name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
Required: True ,
}
string ,
databaseConnectionName:
{
Description: Name of the database 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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_CreateOrUpdateBuildDatabaseConnection (new)
Description :  Description for Create or update a database connection for a static site build
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
Required: True ,
}
string ,
databaseConnectionName:
{
Description: Name of the database connection. ,
Required: True ,
}
string ,
databaseConnectionRequestEnvelope:
{
Description: A JSON representation of the database connection request properties ,
Required: True ,
}
{
properties:
{
Description: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_DeleteBuildDatabaseConnection (new)
Description :  Delete a database connection for a static site build
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
Required: True ,
}
string ,
databaseConnectionName:
{
Description: Name of the database 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)

{}

⚐ 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 ,
}
,
}
StaticSites_UpdateBuildDatabaseConnection (new)
Description :  Description for Create or update a database connection for a static site build
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
Required: True ,
}
string ,
databaseConnectionName:
{
Description: Name of the database connection. ,
Required: True ,
}
string ,
databaseConnectionRequestEnvelope:
{
Description: A JSON representation of the database connection request properties ,
Required: True ,
}
{
properties:
{
Description: DatabaseConnectionPatchRequest resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_GetBuildDatabaseConnectionWithDetails (new)
Description :  Returns details of a database connection for a static site build by name
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}/show
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
Required: True ,
}
string ,
databaseConnectionName:
{
Description: Name of the database 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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_ListStaticSiteBuildFunctions (new)
Description :  Description for Gets the functions of a particular static site build.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/functions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
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: StaticSiteFunctionOverviewARMResource resource specific properties ,
Required: False ,
}
{
functionName:
{
Description: The name for the function ,
Required: False ,
}
string ,
triggerType:
{
Description: The trigger type of the function ,
Enum:
{
HttpTrigger: No description available. ,
Unknown: No description available. ,
}
,
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 ,
}
,
}
StaticSites_ListStaticSiteBuildAppSettings (new)
Description :  Description for Gets the application settings of a static site build.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listAppSettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
StaticSites_ListStaticSiteBuildFunctionAppSettings (new)
Description :  Description for Gets the application settings of a static site build.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listFunctionAppSettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
StaticSites_GetBuildDatabaseConnectionsWithDetails (new)
Description :  Returns details of database connections for a static site build
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/showDatabaseConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_GetUserProvidedFunctionAppsForStaticSiteBuild (new)
Description :  Description for Gets the details of the user provided function apps registered with a static site build
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
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: StaticSiteUserProvidedFunctionAppARMResource resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
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 ,
}
,
}
StaticSites_GetUserProvidedFunctionAppForStaticSiteBuild (new)
Description :  Description for Gets the details of the user provided function app registered with a static site build
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
Required: True ,
}
string ,
functionAppName:
{
Description: Name of the function app registered with the static site build. ,
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: StaticSiteUserProvidedFunctionAppARMResource resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
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 ,
}
,
}
StaticSites_RegisterUserProvidedFunctionAppWithStaticSiteBuild (new)
Description :  Description for Register a user provided function app with a static site build
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
Required: True ,
}
string ,
functionAppName:
{
Description: Name of the function app to register with the static site build. ,
Required: True ,
}
string ,
staticSiteUserProvidedFunctionEnvelope:
{
Description: A JSON representation of the user provided function app properties. See example. ,
Required: True ,
}
{
properties:
{
Description: StaticSiteUserProvidedFunctionAppARMResource resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
isForced:
{
Description: Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: StaticSiteUserProvidedFunctionAppARMResource resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: StaticSiteUserProvidedFunctionAppARMResource resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
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 ,
}
,
}
StaticSites_DetachUserProvidedFunctionAppFromStaticSiteBuild (new)
Description :  Description for Detach the user provided function app from the static site build
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier. ,
Required: True ,
}
string ,
functionAppName:
{
Description: Name of the function app registered with the static site build. ,
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 ,
}
,
}
StaticSites_CreateZipDeploymentForStaticSiteBuild (new)
Description :  Description for Deploys zipped content to a specific environment of a static site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/zipdeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
environmentName:
{
Description: Name of the environment. ,
Required: True ,
}
string ,
staticSiteZipDeploymentEnvelope:
{
Description: A JSON representation of the StaticSiteZipDeployment properties. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
appZipUrl:
{
Description: URL for the zipped app content ,
Required: False ,
}
string ,
apiZipUrl:
{
Description: URL for the zipped api content ,
Required: False ,
}
string ,
deploymentTitle:
{
Description: A title to label the deployment ,
Required: False ,
}
string ,
provider:
{
Description: The provider submitting this deployment ,
Required: False ,
}
string ,
functionLanguage:
{
Description: The language of the api content, if it exists ,
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)

{}

⚐ 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 ,
}
,
}
StaticSites_CreateOrUpdateStaticSiteAppSettings (new)
Description :  Description for Creates or updates the app settings of a static site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/appsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
appSettings:
{
Description: The dictionary containing the static site app settings to update. ,
Required: True ,
}
{
properties:
{
Description: Settings. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
StaticSites_ListBasicAuth (new)
Description :  Description for Gets the basic auth properties for a static site as a collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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: StaticSiteBasicAuthPropertiesARMResource resource specific properties ,
Required: False ,
}
{
password:
{
Description: The password for basic auth. ,
Required: False ,
}
string ,
secretUrl:
{
Description: Url to the secret in Key Vault. ,
Required: False ,
}
string ,
applicableEnvironmentsMode:
{
Description: State indicating if basic auth is enabled and for what environments it is active. ,
Required: True ,
}
string ,
environments:
{
Description: The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments. ,
Required: False ,
}
[
string ,
]
,
secretState:
{
Description: State indicating if basic auth has a secret and what type it is. ,
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 ,
}
,
}
StaticSites_GetBasicAuth (new)
Description :  Description for Gets the basic auth properties for a static site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
basicAuthName:
{
Description: name of the basic auth entry. ,
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: StaticSiteBasicAuthPropertiesARMResource resource specific properties ,
Required: False ,
}
{
password:
{
Description: The password for basic auth. ,
Required: False ,
}
string ,
secretUrl:
{
Description: Url to the secret in Key Vault. ,
Required: False ,
}
string ,
applicableEnvironmentsMode:
{
Description: State indicating if basic auth is enabled and for what environments it is active. ,
Required: True ,
}
string ,
environments:
{
Description: The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments. ,
Required: False ,
}
[
string ,
]
,
secretState:
{
Description: State indicating if basic auth has a secret and what type it is. ,
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 ,
}
,
}
StaticSites_CreateOrUpdateBasicAuth (new)
Description :  Description for Adds or updates basic auth for a static site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
basicAuthName:
{
Description: name of the basic auth entry. ,
Required: True ,
}
string ,
basicAuthEnvelope:
{
Description: A JSON representation of the basic auth properties. ,
Required: True ,
}
{
properties:
{
Description: StaticSiteBasicAuthPropertiesARMResource resource specific properties ,
Required: False ,
}
{
password:
{
Description: The password for basic auth. ,
Required: False ,
}
string ,
secretUrl:
{
Description: Url to the secret in Key Vault. ,
Required: False ,
}
string ,
applicableEnvironmentsMode:
{
Description: State indicating if basic auth is enabled and for what environments it is active. ,
Required: True ,
}
string ,
environments:
{
Description: The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments. ,
Required: False ,
}
[
string ,
]
,
secretState:
{
Description: State indicating if basic auth has a secret and what type it is. ,
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: StaticSiteBasicAuthPropertiesARMResource resource specific properties ,
Required: False ,
}
{
password:
{
Description: The password for basic auth. ,
Required: False ,
}
string ,
secretUrl:
{
Description: Url to the secret in Key Vault. ,
Required: False ,
}
string ,
applicableEnvironmentsMode:
{
Description: State indicating if basic auth is enabled and for what environments it is active. ,
Required: True ,
}
string ,
environments:
{
Description: The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments. ,
Required: False ,
}
[
string ,
]
,
secretState:
{
Description: State indicating if basic auth has a secret and what type it is. ,
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 ,
}
,
}
StaticSites_CreateOrUpdateStaticSiteFunctionAppSettings (new)
Description :  Description for Creates or updates the function app settings of a static site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/functionappsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
appSettings:
{
Description: The dictionary containing the static site function app settings to update. ,
Required: True ,
}
{
properties:
{
Description: Settings. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
StaticSites_ListStaticSiteCustomDomains (new)
Description :  Description for Gets all static site custom domains for a particular static site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site resource to search in. ,
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: StaticSiteCustomDomainOverviewARMResource resource specific properties ,
Required: False ,
}
{
domainName:
{
Description: The domain name for the static site custom domain. ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the custom domain was created for the static site. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the custom domain ,
Enum:
{
RetrievingValidationToken: No description available. ,
Validating: No description available. ,
Adding: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
validationToken:
{
Description: The TXT record validation token ,
Required: False ,
}
string ,
errorMessage:
{
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 ,
}
,
}
StaticSites_GetStaticSiteCustomDomain (new)
Description :  Description for Gets an existing custom domain for a particular static site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site resource to search in. ,
Required: True ,
}
string ,
domainName:
{
Description: The custom domain name. ,
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: StaticSiteCustomDomainOverviewARMResource resource specific properties ,
Required: False ,
}
{
domainName:
{
Description: The domain name for the static site custom domain. ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the custom domain was created for the static site. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the custom domain ,
Enum:
{
RetrievingValidationToken: No description available. ,
Validating: No description available. ,
Adding: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
validationToken:
{
Description: The TXT record validation token ,
Required: False ,
}
string ,
errorMessage:
{
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 ,
}
,
}
StaticSites_CreateOrUpdateStaticSiteCustomDomain (new)
Description :  Description for Creates a new static site custom domain in an existing resource group and static site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
domainName:
{
Description: The custom domain to create. ,
Required: True ,
}
string ,
staticSiteCustomDomainRequestPropertiesEnvelope:
{
Description: A JSON representation of the static site custom domain request properties. See example. ,
Required: True ,
}
{
properties:
{
Description: StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties ,
Required: False ,
}
{
validationMethod:
{
Description: Validation method for adding a custom domain ,
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: StaticSiteCustomDomainOverviewARMResource resource specific properties ,
Required: False ,
}
{
domainName:
{
Description: The domain name for the static site custom domain. ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the custom domain was created for the static site. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the custom domain ,
Enum:
{
RetrievingValidationToken: No description available. ,
Validating: No description available. ,
Adding: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
validationToken:
{
Description: The TXT record validation token ,
Required: False ,
}
string ,
errorMessage:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: StaticSiteCustomDomainOverviewARMResource resource specific properties ,
Required: False ,
}
{
domainName:
{
Description: The domain name for the static site custom domain. ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the custom domain was created for the static site. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the custom domain ,
Enum:
{
RetrievingValidationToken: No description available. ,
Validating: No description available. ,
Adding: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
validationToken:
{
Description: The TXT record validation token ,
Required: False ,
}
string ,
errorMessage:
{
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 ,
}
,
}
StaticSites_DeleteStaticSiteCustomDomain (new)
Description :  Description for Deletes a custom domain.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
domainName:
{
Description: The custom domain to delete. ,
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 (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 ,
}
,
}
StaticSites_ValidateCustomDomainCanBeAddedToStaticSite (new)
Description :  Description for Validates a particular custom domain can be added to a static site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}/validate
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
domainName:
{
Description: The custom domain to validate. ,
Required: True ,
}
string ,
staticSiteCustomDomainRequestPropertiesEnvelope:
{
Description: A JSON representation of the static site custom domain request properties. See example. ,
Required: True ,
}
{
properties:
{
Description: StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties ,
Required: False ,
}
{
validationMethod:
{
Description: Validation method for adding a custom domain ,
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)

{}

⚐ 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 ,
}
,
}
StaticSites_GetDatabaseConnections (new)
Description :  Returns overviews of database connections for a static site
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_GetDatabaseConnection (new)
Description :  Returns overview of a database connection for a static site by name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
databaseConnectionName:
{
Description: Name of the database 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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_CreateOrUpdateDatabaseConnection (new)
Description :  Description for Create or update a database connection for a static site
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
databaseConnectionName:
{
Description: Name of the database connection. ,
Required: True ,
}
string ,
databaseConnectionRequestEnvelope:
{
Description: A JSON representation of the database connection request properties ,
Required: True ,
}
{
properties:
{
Description: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_DeleteDatabaseConnection (new)
Description :  Delete a database connection for a static site
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
databaseConnectionName:
{
Description: Name of the database 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)

{}

⚐ 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 ,
}
,
}
StaticSites_UpdateDatabaseConnection (new)
Description :  Description for Create or update a database connection for a static site
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
databaseConnectionName:
{
Description: Name of the database connection. ,
Required: True ,
}
string ,
databaseConnectionRequestEnvelope:
{
Description: A JSON representation of the database connection request properties ,
Required: True ,
}
{
properties:
{
Description: DatabaseConnectionPatchRequest resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: False ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_GetDatabaseConnectionWithDetails (new)
Description :  Returns details of a database connection for a static site by name
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}/show
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
databaseConnectionName:
{
Description: Name of the database 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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_DetachStaticSite (new)
Description :  Description for Detaches a static site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/detach
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site to detach. ,
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 (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 ,
}
,
}
StaticSites_ListStaticSiteFunctions (new)
Description :  Description for Gets the functions of a static site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/functions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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: StaticSiteFunctionOverviewARMResource resource specific properties ,
Required: False ,
}
{
functionName:
{
Description: The name for the function ,
Required: False ,
}
string ,
triggerType:
{
Description: The trigger type of the function ,
Enum:
{
HttpTrigger: No description available. ,
Unknown: No description available. ,
}
,
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 ,
}
,
}
StaticSites_ListStaticSiteAppSettings (new)
Description :  Description for Gets the application settings of a static site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listAppSettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
StaticSites_ListStaticSiteConfiguredRoles (new)
Description :  Description for Lists the roles configured for the static site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listConfiguredRoles
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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: List of string 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 ,
}
,
}
StaticSites_ListStaticSiteFunctionAppSettings (new)
Description :  Description for Gets the application settings of a static site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listFunctionAppSettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
StaticSites_ListStaticSiteSecrets (new)
Description :  Description for Lists the secrets for an existing static site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listSecrets
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
StaticSites_GetPrivateEndpointConnectionList (new)
Description :  Description for Gets the list of private endpoint connections associated with a static site
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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 ,
}
,
}
StaticSites_GetPrivateEndpointConnection (new)
Description :  Description for Gets a private endpoint connection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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 ,
}
,
}
StaticSites_ApproveOrRejectPrivateEndpointConnection (new)
Description :  Description for Approves or rejects a private endpoint connection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
privateEndpointWrapper:
{
Description: Request body. ,
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 ,
}
,
}
StaticSites_DeletePrivateEndpointConnection (new)
Description :  Description for Deletes a private endpoint connection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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)

{
$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 ,
}
,
}
StaticSites_GetPrivateLinkResources (new)
Description :  Description for Gets the private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateLinkResources
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
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 ,
}
,
}
StaticSites_ResetStaticSiteApiKey (new)
Description :  Description for Resets the api key for an existing static site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/resetapikey
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
resetPropertiesEnvelope:
{
Required: True ,
}
{
properties:
{
Description: StaticSiteResetPropertiesARMResource resource specific properties ,
Required: False ,
}
{
repositoryToken:
{
Description: The token which proves admin privileges to the repository. ,
Required: False ,
}
string ,
shouldUpdateRepository:
{
Description: Determines whether the repository should be updated with the new properties. ,
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)

{}

⚐ 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 ,
}
,
}
StaticSites_GetDatabaseConnectionsWithDetails (new)
Description :  Returns details of database connections for a static site
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/showDatabaseConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
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: DatabaseConnection resource specific properties ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the database. ,
Required: True ,
}
string ,
connectionIdentity:
{
Description: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string to use to connect to the database. ,
Required: False ,
}
string ,
region:
{
Description: The region of the database resource. ,
Required: True ,
}
string ,
configurationFiles:
{
Description: A list of configuration files associated with this database connection. ,
Required: False ,
}
[
{
fileName:
{
Description: The name of the configuration file. ,
Required: False ,
}
string ,
contents:
{
Description: The Base64 encoding of the file contents. ,
Required: False ,
}
string ,
type:
{
Description: The type of configuration file. ,
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 ,
}
,
}
StaticSites_GetUserProvidedFunctionAppsForStaticSite (new)
Description :  Description for Gets the details of the user provided function apps registered with a static site
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
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: StaticSiteUserProvidedFunctionAppARMResource resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
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 ,
}
,
}
StaticSites_GetUserProvidedFunctionAppForStaticSite (new)
Description :  Description for Gets the details of the user provided function app registered with a static site
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
functionAppName:
{
Description: Name of the function app registered with the static site. ,
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: StaticSiteUserProvidedFunctionAppARMResource resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
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 ,
}
,
}
StaticSites_RegisterUserProvidedFunctionAppWithStaticSite (new)
Description :  Description for Register a user provided function app with a static site
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
functionAppName:
{
Description: Name of the function app to register with the static site. ,
Required: True ,
}
string ,
staticSiteUserProvidedFunctionEnvelope:
{
Description: A JSON representation of the user provided function app properties. See example. ,
Required: True ,
}
{
properties:
{
Description: StaticSiteUserProvidedFunctionAppARMResource resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
isForced:
{
Description: Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: StaticSiteUserProvidedFunctionAppARMResource resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: StaticSiteUserProvidedFunctionAppARMResource resource specific properties ,
Required: False ,
}
{
functionAppResourceId:
{
Description: The resource id of the function app registered with the static site ,
Required: False ,
}
string ,
functionAppRegion:
{
Description: The region of the function app registered with the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the function app was registered with the static site. ,
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 ,
}
,
}
StaticSites_DetachUserProvidedFunctionAppFromStaticSite (new)
Description :  Description for Detach the user provided function app from the static site
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
functionAppName:
{
Description: Name of the function app registered with the static site. ,
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 ,
}
,
}
StaticSites_CreateZipDeploymentForStaticSite (new)
Description :  Description for Deploys zipped content to a static site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/zipdeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site. ,
Required: True ,
}
string ,
staticSiteZipDeploymentEnvelope:
{
Description: A JSON representation of the StaticSiteZipDeployment properties. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
appZipUrl:
{
Description: URL for the zipped app content ,
Required: False ,
}
string ,
apiZipUrl:
{
Description: URL for the zipped api content ,
Required: False ,
}
string ,
deploymentTitle:
{
Description: A title to label the deployment ,
Required: False ,
}
string ,
provider:
{
Description: The provider submitting this deployment ,
Required: False ,
}
string ,
functionLanguage:
{
Description: The language of the api content, if it exists ,
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)

{}

⚐ 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 ,
}
,
}
StaticSites_ValidateBackend (new)
Description :  Validates that a backend can be linked to a static site
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}/validate
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
linkedBackendName:
{
Description: Name of the linked backend that should be retrieved ,
Required: True ,
}
string ,
staticSiteLinkedBackendEnvelope:
{
Description: A JSON representation of the linked backend request properties ,
Required: True ,
}
{
properties:
{
Description: StaticSiteLinkedBackendARMResource resource specific properties ,
Required: False ,
}
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
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 (204)

{}

⚐ 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 ,
}
,
}
StaticSites_ValidateBackendForBuild (new)
Description :  Validates that a backend can be linked to a static site build
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}/validate
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier ,
Required: True ,
}
string ,
linkedBackendName:
{
Description: Name of the linked backend that should be retrieved ,
Required: True ,
}
string ,
staticSiteLinkedBackendEnvelope:
{
Description: A JSON representation of the linked backend request properties ,
Required: True ,
}
{
properties:
{
Description: StaticSiteLinkedBackendARMResource resource specific properties ,
Required: False ,
}
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
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 (204)

{}

⚐ 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 ,
}
,
}
StaticSites_GetLinkedBackends (new)
Description :  Returns details of all backends linked to a static site
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
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: StaticSiteLinkedBackendARMResource resource specific properties ,
Required: False ,
}
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
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 ,
}
,
}
StaticSites_GetLinkedBackendsForBuild (new)
Description :  Returns details of all backends linked to a static site build
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier ,
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: StaticSiteLinkedBackendARMResource resource specific properties ,
Required: False ,
}
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
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 ,
}
,
}
StaticSites_GetLinkedBackend (new)
Description :  Returns the details of a linked backend linked to a static site by name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
linkedBackendName:
{
Description: Name of the linked backend that should be retrieved ,
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: StaticSiteLinkedBackendARMResource resource specific properties ,
Required: False ,
}
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
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 ,
}
,
}
StaticSites_LinkBackend (new)
Description :  Link backend to a static site
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
linkedBackendName:
{
Description: Name of the backend to link to the static site ,
Required: True ,
}
string ,
staticSiteLinkedBackendEnvelope:
{
Description: A JSON representation of the linked backend request properties ,
Required: True ,
}
{
properties:
{
Description: StaticSiteLinkedBackendARMResource resource specific properties ,
Required: False ,
}
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
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: StaticSiteLinkedBackendARMResource resource specific properties ,
Required: False ,
}
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
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 ,
}
,
}
StaticSites_UnlinkBackend (new)
Description :  Unlink a backend from a static site
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
linkedBackendName:
{
Description: Name of the backend linked to the static site ,
Required: True ,
}
string ,
isCleaningAuthConfig:
{
Description: Decides if Easy Auth configuration will be removed from backend configuration ,
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 (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 ,
}
,
}
StaticSites_GetLinkedBackendForBuild (new)
Description :  Returns the details of a linked backend linked to a static site build by name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier ,
Required: True ,
}
string ,
linkedBackendName:
{
Description: Name of the linked backend that should be retrieved ,
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: StaticSiteLinkedBackendARMResource resource specific properties ,
Required: False ,
}
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
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 ,
}
,
}
StaticSites_LinkBackendToBuild (new)
Description :  Link backend to a static site build
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier ,
Required: True ,
}
string ,
linkedBackendName:
{
Description: Name of the backend to link to the static site ,
Required: True ,
}
string ,
staticSiteLinkedBackendEnvelope:
{
Description: A JSON representation of the linked backend request properties ,
Required: True ,
}
{
properties:
{
Description: StaticSiteLinkedBackendARMResource resource specific properties ,
Required: False ,
}
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
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: StaticSiteLinkedBackendARMResource resource specific properties ,
Required: False ,
}
{
backendResourceId:
{
Description: The resource id of the backend linked to the static site ,
Required: False ,
}
string ,
region:
{
Description: The region of the backend linked to the static site ,
Required: False ,
}
string ,
createdOn:
{
Description: The date and time on which the backend was linked to the static site. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linking process. ,
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 ,
}
,
}
StaticSites_UnlinkBackendFromBuild (new)
Description :  Unlink a backend from a static site build
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the static site ,
Required: True ,
}
string ,
environmentName:
{
Description: The stage site identifier ,
Required: True ,
}
string ,
linkedBackendName:
{
Description: Name of the backend linked to the static site ,
Required: True ,
}
string ,
isCleaningAuthConfig:
{
Description: Decides if auth will be removed from backend configuration ,
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 (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 ,
}
,
}
WebApps_List (new)
Description :  Description for Get all apps for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites
{
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 ,
}
,
}
WebApps_ListByResourceGroup (new)
Description :  Description for Gets all web, mobile, and API apps in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
includeSlots:
{
Description: Specify true to include deployment slots in results. The default is false, which only gives you the production slot of all 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 (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 ,
}
,
}
WebApps_Get (new)
Description :  Description for Gets the details of a web, mobile, or API app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: 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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdate (new)
Description :  Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: A JSON representation of the app properties. See example. ,
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 ,
}
,
}
,
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: 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 ,
}
,
}

⚐ Response (202)

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

⚐ 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 ,
}
,
}
WebApps_Delete (new)
Description :  Description for Deletes a web, mobile, or API app, or one of the deployment slots.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app to delete. ,
Required: True ,
}
string ,
deleteMetrics:
{
Description: If true, web app metrics are also deleted. ,
Required: False ,
}
boolean ,
deleteEmptyServerFarm:
{
Description: Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted. ,
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)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_Update (new)
Description :  Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: A JSON representation of the app properties. See example. ,
Required: True ,
}
{
properties:
{
Description: SitePatchResource 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 ,
}
,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
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 ,
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 ,
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 ,
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 ,
}
,
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: 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 ,
}
,
}

⚐ Response (202)

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

⚐ 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 ,
}
,
}
WebApps_AnalyzeCustomHostname (new)
Description :  Description for Analyze a custom hostname.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
hostName:
{
Description: Custom hostname. ,
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: CustomHostnameAnalysisResult resource specific properties ,
Required: False ,
}
{
isHostnameAlreadyVerified:
{
Description: true if hostname is already verified; otherwise, false. ,
Required: False ,
}
boolean ,
customDomainVerificationTest:
{
Description: DNS verification test result. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
customDomainVerificationFailureInfo:
{
Description: Raw failure information if DNS verification fails. ,
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 ,
}
,
hasConflictOnScaleUnit:
{
Description: true if there is a conflict on a scale unit; otherwise, false. ,
Required: False ,
}
boolean ,
hasConflictAcrossSubscription:
{
Description: true if there is a conflict across subscriptions; otherwise, false. ,
Required: False ,
}
boolean ,
conflictingAppResourceId:
{
Description: Name of the conflicting app on scale unit if it's within the same subscription. ,
Required: False ,
}
string ,
cNameRecords:
{
Description: CName records controller can see for this hostname. ,
Required: False ,
}
[
string ,
]
,
txtRecords:
{
Description: TXT records controller can see for this hostname. ,
Required: False ,
}
[
string ,
]
,
aRecords:
{
Description: A records controller can see for this hostname. ,
Required: False ,
}
[
string ,
]
,
alternateCNameRecords:
{
Description: Alternate CName records controller can see for this hostname. ,
Required: False ,
}
[
string ,
]
,
alternateTxtRecords:
{
Description: Alternate TXT records controller can see for this hostname. ,
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 ,
}
,
}
WebApps_ApplySlotConfigToProduction (new)
Description :  Description for Applies the configuration settings from the target slot onto the current slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: JSON object that contains the target slot name. See example. ,
Required: True ,
}
{
targetSlot:
{
Description: Destination deployment slot during swap operation. ,
Required: True ,
}
string ,
preserveVnet:
{
Description: true to preserve Virtual Network to the slot during swap; otherwise, false. ,
Required: True ,
}
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)

{}

⚐ 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 ,
}
,
}
WebApps_Backup (new)
Description :  Description for Creates a backup of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
request:
{
Description: Backup configuration. You can use the JSON response from the POST action as input here. ,
Required: True ,
}
{
properties:
{
Description: BackupRequest resource specific properties ,
Required: False ,
}
{
backupName:
{
Description: Name of the backup. ,
Required: False ,
}
string ,
enabled:
{
Description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. ,
Required: False ,
}
boolean ,
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically. ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyUnit:
{
Description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) ,
Enum:
{
Day: No description available. ,
Hour: No description available. ,
}
,
Required: True ,
}
enum ,
keepAtLeastOneBackup:
{
Description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. ,
Required: True ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted. ,
Format: int32 ,
Required: True ,
}
integer ,
startTime:
{
Description: When the schedule should start working. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: Last time when this schedule was triggered. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
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: BackupItem resource specific properties ,
Required: False ,
}
{
id:
{
Description: Id of the backup. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: SAS URL for the storage account container which contains this backup. ,
Required: False ,
}
string ,
blobName:
{
Description: Name of the blob which contains data for this backup. ,
Required: False ,
}
string ,
name:
{
Description: Name of this backup. ,
Required: False ,
}
string ,
status:
{
Description: Backup status. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
Skipped: No description available. ,
PartiallySucceeded: No description available. ,
DeleteInProgress: No description available. ,
DeleteFailed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: Size of the backup in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: Timestamp of the backup creation. ,
Format: date-time ,
Required: False ,
}
string ,
log:
{
Description: Details regarding this backup. Might contain an error message. ,
Required: False ,
}
string ,
databases:
{
Description: List of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
scheduled:
{
Description: True if this backup has been created due to a schedule being triggered. ,
Required: False ,
}
boolean ,
lastRestoreTimeStamp:
{
Description: Timestamp of a last restore operation which used this backup. ,
Format: date-time ,
Required: False ,
}
string ,
finishedTimeStamp:
{
Description: Timestamp when this backup finished. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. ,
Required: False ,
}
string ,
websiteSizeInBytes:
{
Description: Size of the original web app which has been backed up. ,
Format: int64 ,
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 ,
}
,
}
WebApps_ListBackups (new)
Description :  Description for Gets existing backups of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: BackupItem resource specific properties ,
Required: False ,
}
{
id:
{
Description: Id of the backup. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: SAS URL for the storage account container which contains this backup. ,
Required: False ,
}
string ,
blobName:
{
Description: Name of the blob which contains data for this backup. ,
Required: False ,
}
string ,
name:
{
Description: Name of this backup. ,
Required: False ,
}
string ,
status:
{
Description: Backup status. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
Skipped: No description available. ,
PartiallySucceeded: No description available. ,
DeleteInProgress: No description available. ,
DeleteFailed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: Size of the backup in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: Timestamp of the backup creation. ,
Format: date-time ,
Required: False ,
}
string ,
log:
{
Description: Details regarding this backup. Might contain an error message. ,
Required: False ,
}
string ,
databases:
{
Description: List of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
scheduled:
{
Description: True if this backup has been created due to a schedule being triggered. ,
Required: False ,
}
boolean ,
lastRestoreTimeStamp:
{
Description: Timestamp of a last restore operation which used this backup. ,
Format: date-time ,
Required: False ,
}
string ,
finishedTimeStamp:
{
Description: Timestamp when this backup finished. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. ,
Required: False ,
}
string ,
websiteSizeInBytes:
{
Description: Size of the original web app which has been backed up. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_GetBackupStatus (new)
Description :  Description for Gets a backup of an app by its ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
backupId:
{
Description: ID of the backup. ,
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: BackupItem resource specific properties ,
Required: False ,
}
{
id:
{
Description: Id of the backup. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: SAS URL for the storage account container which contains this backup. ,
Required: False ,
}
string ,
blobName:
{
Description: Name of the blob which contains data for this backup. ,
Required: False ,
}
string ,
name:
{
Description: Name of this backup. ,
Required: False ,
}
string ,
status:
{
Description: Backup status. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
Skipped: No description available. ,
PartiallySucceeded: No description available. ,
DeleteInProgress: No description available. ,
DeleteFailed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: Size of the backup in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: Timestamp of the backup creation. ,
Format: date-time ,
Required: False ,
}
string ,
log:
{
Description: Details regarding this backup. Might contain an error message. ,
Required: False ,
}
string ,
databases:
{
Description: List of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
scheduled:
{
Description: True if this backup has been created due to a schedule being triggered. ,
Required: False ,
}
boolean ,
lastRestoreTimeStamp:
{
Description: Timestamp of a last restore operation which used this backup. ,
Format: date-time ,
Required: False ,
}
string ,
finishedTimeStamp:
{
Description: Timestamp when this backup finished. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. ,
Required: False ,
}
string ,
websiteSizeInBytes:
{
Description: Size of the original web app which has been backed up. ,
Format: int64 ,
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 ,
}
,
}
WebApps_DeleteBackup (new)
Description :  Description for Deletes a backup of an app by its ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_ListBackupStatusSecrets (new)
Description :  Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
backupId:
{
Description: ID of backup. ,
Required: True ,
}
string ,
request:
{
Description: Information on backup request. ,
Required: True ,
}
{
properties:
{
Description: BackupRequest resource specific properties ,
Required: False ,
}
{
backupName:
{
Description: Name of the backup. ,
Required: False ,
}
string ,
enabled:
{
Description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. ,
Required: False ,
}
boolean ,
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically. ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyUnit:
{
Description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) ,
Enum:
{
Day: No description available. ,
Hour: No description available. ,
}
,
Required: True ,
}
enum ,
keepAtLeastOneBackup:
{
Description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. ,
Required: True ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted. ,
Format: int32 ,
Required: True ,
}
integer ,
startTime:
{
Description: When the schedule should start working. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: Last time when this schedule was triggered. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
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: BackupItem resource specific properties ,
Required: False ,
}
{
id:
{
Description: Id of the backup. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: SAS URL for the storage account container which contains this backup. ,
Required: False ,
}
string ,
blobName:
{
Description: Name of the blob which contains data for this backup. ,
Required: False ,
}
string ,
name:
{
Description: Name of this backup. ,
Required: False ,
}
string ,
status:
{
Description: Backup status. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
Skipped: No description available. ,
PartiallySucceeded: No description available. ,
DeleteInProgress: No description available. ,
DeleteFailed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: Size of the backup in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: Timestamp of the backup creation. ,
Format: date-time ,
Required: False ,
}
string ,
log:
{
Description: Details regarding this backup. Might contain an error message. ,
Required: False ,
}
string ,
databases:
{
Description: List of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
scheduled:
{
Description: True if this backup has been created due to a schedule being triggered. ,
Required: False ,
}
boolean ,
lastRestoreTimeStamp:
{
Description: Timestamp of a last restore operation which used this backup. ,
Format: date-time ,
Required: False ,
}
string ,
finishedTimeStamp:
{
Description: Timestamp when this backup finished. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. ,
Required: False ,
}
string ,
websiteSizeInBytes:
{
Description: Size of the original web app which has been backed up. ,
Format: int64 ,
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 ,
}
,
}
WebApps_Restore (new)
Description :  Description for Restores a specific backup to another app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
backupId:
{
Description: ID of the backup. ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request . ,
Required: True ,
}
{
properties:
{
Description: RestoreRequest resource specific properties ,
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup. ,
Required: False ,
}
string ,
overwrite:
{
Description: true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. ,
Required: True ,
}
boolean ,
siteName:
{
Description: Name of an app. ,
Required: False ,
}
string ,
databases:
{
Description: Collection of databases which should be restored. This list has to match the list of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
ignoreConflictingHostNames:
{
Description: Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
ignoreDatabases:
{
Description: Ignore the databases and only restore the site content ,
Required: False ,
}
boolean ,
appServicePlan:
{
Description: Specify app service plan that will own restored site. ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
Snapshot: No description available. ,
CloudFS: No description available. ,
}
,
Required: False ,
}
enum ,
adjustConnectionStrings:
{
Description: true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false. ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring an app to an App Service Environment). ,
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 (202)

{}

⚐ 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 ,
}
,
}
WebApps_ListBasicPublishingCredentialsPolicies (new)
Description :  Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
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 ,
}
,
}
WebApps_GetFtpAllowed (new)
Description :  Description for Returns whether FTP is allowed on the site or not.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateFtpAllowed (new)
Description :  Description for Updates whether FTP is allowed on the site or not.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
csmPublishingAccessPoliciesEntity:
{
Required: True ,
}
{
properties:
{
Description: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
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)

{
properties:
{
Description: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_GetScmAllowed (new)
Description :  Description for Returns whether Scm basic auth is allowed on the site or not.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateScmAllowed (new)
Description :  Description for Updates whether user publishing credentials are allowed on the site or not.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
csmPublishingAccessPoliciesEntity:
{
Required: True ,
}
{
properties:
{
Description: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
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)

{
properties:
{
Description: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListConfigurations (new)
Description :  Description for List the configurations of an app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 ,
}
{
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 ,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_UpdateApplicationSettings (new)
Description :  Description for Replaces the application settings of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
appSettings:
{
Description: Application settings of the app. ,
Required: True ,
}
{
properties:
{
Description: Settings. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListApplicationSettings (new)
Description :  Description for Gets the application settings of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_UpdateAuthSettings (new)
Description :  Description for Updates the Authentication / Authorization settings associated with web app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
siteAuthSettings:
{
Description: Auth settings associated with web app. ,
Required: True ,
}
{
properties:
{
Description: SiteAuthSettings resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
Github: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
issuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
validateIssuer:
{
Description: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. ,
Required: False ,
}
boolean ,
allowedAudiences:
{
Description: Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClaimsAuthorization:
{
Description: Gets a JSON string containing the Azure AD Acl settings. ,
Required: False ,
}
string ,
googleClientId:
{
Description: The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecretSettingName:
{
Description: The app setting name that contains the client secret associated with the Google web application. ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecretSettingName:
{
Description: The app setting name that contains the app secret used for Facebook Login. ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
gitHubClientId:
{
Description: The Client Id of the GitHub app used for login. This setting is required for enabling Github login ,
Required: False ,
}
string ,
gitHubClientSecret:
{
Description: The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login. ,
Required: False ,
}
string ,
gitHubClientSecretSettingName:
{
Description: The app setting name that contains the client secret of the Github app used for GitHub Login. ,
Required: False ,
}
string ,
gitHubOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecretSettingName:
{
Description: The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
isAuthFromFile:
{
Description: "true" if the auth config settings should be read from a file, "false" otherwise ,
Required: False ,
}
string ,
authFilePath:
{
Description: The path of the config file containing auth settings. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
configVersion:
{
Description: The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization. ,
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: SiteAuthSettings resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
Github: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
issuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
validateIssuer:
{
Description: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. ,
Required: False ,
}
boolean ,
allowedAudiences:
{
Description: Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClaimsAuthorization:
{
Description: Gets a JSON string containing the Azure AD Acl settings. ,
Required: False ,
}
string ,
googleClientId:
{
Description: The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecretSettingName:
{
Description: The app setting name that contains the client secret associated with the Google web application. ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecretSettingName:
{
Description: The app setting name that contains the app secret used for Facebook Login. ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
gitHubClientId:
{
Description: The Client Id of the GitHub app used for login. This setting is required for enabling Github login ,
Required: False ,
}
string ,
gitHubClientSecret:
{
Description: The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login. ,
Required: False ,
}
string ,
gitHubClientSecretSettingName:
{
Description: The app setting name that contains the client secret of the Github app used for GitHub Login. ,
Required: False ,
}
string ,
gitHubOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecretSettingName:
{
Description: The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
isAuthFromFile:
{
Description: "true" if the auth config settings should be read from a file, "false" otherwise ,
Required: False ,
}
string ,
authFilePath:
{
Description: The path of the config file containing auth settings. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
configVersion:
{
Description: The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization. ,
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 ,
}
,
}
WebApps_GetAuthSettings (new)
Description :  Description for Gets the Authentication/Authorization settings of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: SiteAuthSettings resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
Github: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
issuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
validateIssuer:
{
Description: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. ,
Required: False ,
}
boolean ,
allowedAudiences:
{
Description: Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClaimsAuthorization:
{
Description: Gets a JSON string containing the Azure AD Acl settings. ,
Required: False ,
}
string ,
googleClientId:
{
Description: The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecretSettingName:
{
Description: The app setting name that contains the client secret associated with the Google web application. ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecretSettingName:
{
Description: The app setting name that contains the app secret used for Facebook Login. ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
gitHubClientId:
{
Description: The Client Id of the GitHub app used for login. This setting is required for enabling Github login ,
Required: False ,
}
string ,
gitHubClientSecret:
{
Description: The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login. ,
Required: False ,
}
string ,
gitHubClientSecretSettingName:
{
Description: The app setting name that contains the client secret of the Github app used for GitHub Login. ,
Required: False ,
}
string ,
gitHubOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecretSettingName:
{
Description: The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
isAuthFromFile:
{
Description: "true" if the auth config settings should be read from a file, "false" otherwise ,
Required: False ,
}
string ,
authFilePath:
{
Description: The path of the config file containing auth settings. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
configVersion:
{
Description: The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization. ,
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 ,
}
,
}
WebApps_GetAuthSettingsV2WithoutSecrets (new)
Description :  Description for Gets site's Authentication / Authorization settings for apps via the V2 format
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: SiteAuthSettingsV2 resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of App Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
configFilePath:
{
Description: The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
requireAuthentication:
{
Description: true if the authentication flow is required any request is made; otherwise, false. ,
Required: False ,
}
boolean ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
Description: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
legacyMicrosoftAccount:
{
Description: The configuration settings of the legacy Microsoft Account provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the legacy Microsoft Account provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the legacy Microsoft Account provider token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
fileSystem:
{
Description: The configuration settings of the storage of the tokens if a file system is used. ,
Required: False ,
}
{
directory:
{
Description: The directory in which the tokens will be stored. ,
Required: False ,
}
string ,
}
,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app setting containing the SAS URL of the blob storage containing the tokens. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
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 ,
}
,
}
WebApps_UpdateAuthSettingsV2 (new)
Description :  Description for Updates site's Authentication / Authorization settings for apps via the V2 format
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
siteAuthSettingsV2:
{
Description: Auth settings associated with web app. ,
Required: True ,
}
{
properties:
{
Description: SiteAuthSettingsV2 resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of App Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
configFilePath:
{
Description: The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
requireAuthentication:
{
Description: true if the authentication flow is required any request is made; otherwise, false. ,
Required: False ,
}
boolean ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
Description: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
legacyMicrosoftAccount:
{
Description: The configuration settings of the legacy Microsoft Account provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the legacy Microsoft Account provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the legacy Microsoft Account provider token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
fileSystem:
{
Description: The configuration settings of the storage of the tokens if a file system is used. ,
Required: False ,
}
{
directory:
{
Description: The directory in which the tokens will be stored. ,
Required: False ,
}
string ,
}
,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app setting containing the SAS URL of the blob storage containing the tokens. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
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: SiteAuthSettingsV2 resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of App Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
configFilePath:
{
Description: The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
requireAuthentication:
{
Description: true if the authentication flow is required any request is made; otherwise, false. ,
Required: False ,
}
boolean ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
Description: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
legacyMicrosoftAccount:
{
Description: The configuration settings of the legacy Microsoft Account provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the legacy Microsoft Account provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the legacy Microsoft Account provider token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
fileSystem:
{
Description: The configuration settings of the storage of the tokens if a file system is used. ,
Required: False ,
}
{
directory:
{
Description: The directory in which the tokens will be stored. ,
Required: False ,
}
string ,
}
,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app setting containing the SAS URL of the blob storage containing the tokens. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
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 ,
}
,
}
WebApps_GetAuthSettingsV2 (new)
Description :  Description for Gets site's Authentication / Authorization settings for apps via the V2 format
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: SiteAuthSettingsV2 resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of App Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
configFilePath:
{
Description: The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
requireAuthentication:
{
Description: true if the authentication flow is required any request is made; otherwise, false. ,
Required: False ,
}
boolean ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
Description: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
legacyMicrosoftAccount:
{
Description: The configuration settings of the legacy Microsoft Account provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the legacy Microsoft Account provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the legacy Microsoft Account provider token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
fileSystem:
{
Description: The configuration settings of the storage of the tokens if a file system is used. ,
Required: False ,
}
{
directory:
{
Description: The directory in which the tokens will be stored. ,
Required: False ,
}
string ,
}
,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app setting containing the SAS URL of the blob storage containing the tokens. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
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 ,
}
,
}
WebApps_UpdateAzureStorageAccounts (new)
Description :  Description for Updates the Azure storage account configurations of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
azureStorageAccounts:
{
Description: Azure storage accounts of the app. ,
Required: True ,
}
{
properties:
{
Description: Azure storage accounts. ,
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: Azure storage accounts. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListAzureStorageAccounts (new)
Description :  Description for Gets the Azure storage account configurations of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: Azure storage accounts. ,
Required: False ,
}
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 ,
}
,
}
WebApps_UpdateBackupConfiguration (new)
Description :  Description for Updates the backup configuration of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
request:
{
Description: Edited backup configuration. ,
Required: True ,
}
{
properties:
{
Description: BackupRequest resource specific properties ,
Required: False ,
}
{
backupName:
{
Description: Name of the backup. ,
Required: False ,
}
string ,
enabled:
{
Description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. ,
Required: False ,
}
boolean ,
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically. ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyUnit:
{
Description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) ,
Enum:
{
Day: No description available. ,
Hour: No description available. ,
}
,
Required: True ,
}
enum ,
keepAtLeastOneBackup:
{
Description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. ,
Required: True ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted. ,
Format: int32 ,
Required: True ,
}
integer ,
startTime:
{
Description: When the schedule should start working. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: Last time when this schedule was triggered. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
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: BackupRequest resource specific properties ,
Required: False ,
}
{
backupName:
{
Description: Name of the backup. ,
Required: False ,
}
string ,
enabled:
{
Description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. ,
Required: False ,
}
boolean ,
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically. ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyUnit:
{
Description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) ,
Enum:
{
Day: No description available. ,
Hour: No description available. ,
}
,
Required: True ,
}
enum ,
keepAtLeastOneBackup:
{
Description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. ,
Required: True ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted. ,
Format: int32 ,
Required: True ,
}
integer ,
startTime:
{
Description: When the schedule should start working. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: Last time when this schedule was triggered. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
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 ,
}
,
}
WebApps_DeleteBackupConfiguration (new)
Description :  Description for Deletes the backup configuration of an app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 ,
}
,
}
WebApps_GetBackupConfiguration (new)
Description :  Description for Gets the backup configuration of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: BackupRequest resource specific properties ,
Required: False ,
}
{
backupName:
{
Description: Name of the backup. ,
Required: False ,
}
string ,
enabled:
{
Description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. ,
Required: False ,
}
boolean ,
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically. ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyUnit:
{
Description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) ,
Enum:
{
Day: No description available. ,
Hour: No description available. ,
}
,
Required: True ,
}
enum ,
keepAtLeastOneBackup:
{
Description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. ,
Required: True ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted. ,
Format: int32 ,
Required: True ,
}
integer ,
startTime:
{
Description: When the schedule should start working. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: Last time when this schedule was triggered. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
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 ,
}
,
}
WebApps_GetAppSettingsKeyVaultReferences (new)
Description :  Description for Gets the config reference app settings and status of an app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: ApiKVReference resource specific properties ,
Required: False ,
}
{
reference:
{
Required: False ,
}
string ,
status:
{
Enum:
{
Initialized: No description available. ,
Resolved: No description available. ,
InvalidSyntax: No description available. ,
MSINotEnabled: No description available. ,
VaultNotFound: No description available. ,
SecretNotFound: No description available. ,
SecretVersionNotFound: No description available. ,
AccessToKeyVaultDenied: No description available. ,
OtherReasons: No description available. ,
FetchTimedOut: No description available. ,
UnauthorizedClient: No description available. ,
}
,
Required: False ,
}
enum ,
vaultName:
{
Required: False ,
}
string ,
secretName:
{
Required: False ,
}
string ,
secretVersion:
{
Required: False ,
}
string ,
identityType:
{
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 ,
}
,
details:
{
Required: False ,
}
string ,
source:
{
Enum:
{
KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
activeVersion:
{
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 ,
}
,
}
WebApps_GetAppSettingKeyVaultReference (new)
Description :  Description for Gets the config reference and status of an app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings/{appSettingKey}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
appSettingKey:
{
Description: App Setting key name. ,
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: ApiKVReference resource specific properties ,
Required: False ,
}
{
reference:
{
Required: False ,
}
string ,
status:
{
Enum:
{
Initialized: No description available. ,
Resolved: No description available. ,
InvalidSyntax: No description available. ,
MSINotEnabled: No description available. ,
VaultNotFound: No description available. ,
SecretNotFound: No description available. ,
SecretVersionNotFound: No description available. ,
AccessToKeyVaultDenied: No description available. ,
OtherReasons: No description available. ,
FetchTimedOut: No description available. ,
UnauthorizedClient: No description available. ,
}
,
Required: False ,
}
enum ,
vaultName:
{
Required: False ,
}
string ,
secretName:
{
Required: False ,
}
string ,
secretVersion:
{
Required: False ,
}
string ,
identityType:
{
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 ,
}
,
details:
{
Required: False ,
}
string ,
source:
{
Enum:
{
KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
activeVersion:
{
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 ,
}
,
}
WebApps_GetSiteConnectionStringKeyVaultReferences (new)
Description :  Description for Gets the config reference app settings and status of an app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: ApiKVReference resource specific properties ,
Required: False ,
}
{
reference:
{
Required: False ,
}
string ,
status:
{
Enum:
{
Initialized: No description available. ,
Resolved: No description available. ,
InvalidSyntax: No description available. ,
MSINotEnabled: No description available. ,
VaultNotFound: No description available. ,
SecretNotFound: No description available. ,
SecretVersionNotFound: No description available. ,
AccessToKeyVaultDenied: No description available. ,
OtherReasons: No description available. ,
FetchTimedOut: No description available. ,
UnauthorizedClient: No description available. ,
}
,
Required: False ,
}
enum ,
vaultName:
{
Required: False ,
}
string ,
secretName:
{
Required: False ,
}
string ,
secretVersion:
{
Required: False ,
}
string ,
identityType:
{
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 ,
}
,
details:
{
Required: False ,
}
string ,
source:
{
Enum:
{
KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
activeVersion:
{
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 ,
}
,
}
WebApps_GetSiteConnectionStringKeyVaultReference (new)
Description :  Description for Gets the config reference and status of an app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings/{connectionStringKey}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
connectionStringKey:
{
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: ApiKVReference resource specific properties ,
Required: False ,
}
{
reference:
{
Required: False ,
}
string ,
status:
{
Enum:
{
Initialized: No description available. ,
Resolved: No description available. ,
InvalidSyntax: No description available. ,
MSINotEnabled: No description available. ,
VaultNotFound: No description available. ,
SecretNotFound: No description available. ,
SecretVersionNotFound: No description available. ,
AccessToKeyVaultDenied: No description available. ,
OtherReasons: No description available. ,
FetchTimedOut: No description available. ,
UnauthorizedClient: No description available. ,
}
,
Required: False ,
}
enum ,
vaultName:
{
Required: False ,
}
string ,
secretName:
{
Required: False ,
}
string ,
secretVersion:
{
Required: False ,
}
string ,
identityType:
{
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 ,
}
,
details:
{
Required: False ,
}
string ,
source:
{
Enum:
{
KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
activeVersion:
{
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 ,
}
,
}
WebApps_UpdateConnectionStrings (new)
Description :  Description for Replaces the connection strings of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
connectionStrings:
{
Description: Connection strings of the app or deployment slot. See example. ,
Required: True ,
}
{
properties:
{
Description: Connection strings. ,
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: Connection strings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListConnectionStrings (new)
Description :  Description for Gets the connection strings of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: Connection strings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_GetDiagnosticLogsConfiguration (new)
Description :  Description for Gets the logging configuration of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: SiteLogsConfig resource specific properties ,
Required: False ,
}
{
applicationLogs:
{
Description: Application logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Application logs to file system configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureTableStorage:
{
Description: Application logs to azure table storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS URL to an Azure table with add/query/delete permissions. ,
Required: True ,
}
string ,
}
,
azureBlobStorage:
{
Description: Application logs to blob storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
httpLogs:
{
Description: HTTP logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Http logs to file system configuration. ,
Required: False ,
}
{
retentionInMb:
{
Description: Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
retentionInDays:
{
Description: Retention in days. Remove files older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
azureBlobStorage:
{
Description: Http logs to azure blob storage configuration. ,
Required: False ,
}
{
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateDiagnosticLogsConfig (new)
Description :  Description for Updates the logging configuration of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
siteLogsConfig:
{
Description: A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties" property. ,
Required: True ,
}
{
properties:
{
Description: SiteLogsConfig resource specific properties ,
Required: False ,
}
{
applicationLogs:
{
Description: Application logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Application logs to file system configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureTableStorage:
{
Description: Application logs to azure table storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS URL to an Azure table with add/query/delete permissions. ,
Required: True ,
}
string ,
}
,
azureBlobStorage:
{
Description: Application logs to blob storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
httpLogs:
{
Description: HTTP logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Http logs to file system configuration. ,
Required: False ,
}
{
retentionInMb:
{
Description: Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
retentionInDays:
{
Description: Retention in days. Remove files older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
azureBlobStorage:
{
Description: Http logs to azure blob storage configuration. ,
Required: False ,
}
{
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
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)

{
properties:
{
Description: SiteLogsConfig resource specific properties ,
Required: False ,
}
{
applicationLogs:
{
Description: Application logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Application logs to file system configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureTableStorage:
{
Description: Application logs to azure table storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS URL to an Azure table with add/query/delete permissions. ,
Required: True ,
}
string ,
}
,
azureBlobStorage:
{
Description: Application logs to blob storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
httpLogs:
{
Description: HTTP logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Http logs to file system configuration. ,
Required: False ,
}
{
retentionInMb:
{
Description: Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
retentionInDays:
{
Description: Retention in days. Remove files older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
azureBlobStorage:
{
Description: Http logs to azure blob storage configuration. ,
Required: False ,
}
{
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateMetadata (new)
Description :  Description for Replaces the metadata of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
metadata:
{
Description: Edited metadata of the app or deployment slot. See example. ,
Required: True ,
}
{
properties:
{
Description: Settings. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListMetadata (new)
Description :  Description for Gets the metadata of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListPublishingCredentials (new)
Description :  Description for Gets the Git/FTP publishing credentials of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: User resource specific properties ,
Required: False ,
}
{
publishingUserName:
{
Description: Username used for publishing. ,
Required: True ,
}
string ,
publishingPassword:
{
Description: Password used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHash:
{
Description: Password hash used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHashSalt:
{
Description: Password hash salt used for publishing. ,
Format: password ,
Required: False ,
}
string ,
scmUri:
{
Description: Url of SCM site. ,
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 ,
}
,
}
WebApps_UpdateSitePushSettings (new)
Description :  Description for Updates the Push settings associated with web app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
pushSettings:
{
Description: Push settings associated with web app. ,
Required: True ,
}
{
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 ,
}
,
}
,
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: 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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListSitePushSettings (new)
Description :  Description for Gets the Push settings associated with web app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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: 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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListSlotConfigurationNames (new)
Description :  Description for Gets the names of app settings and connection strings that stick to the slot (not swapped).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 ,
}
{
connectionStringNames:
{
Description: List of connection string names. ,
Required: False ,
}
[
string ,
]
,
appSettingNames:
{
Description: List of application settings names. ,
Required: False ,
}
[
string ,
]
,
azureStorageConfigNames:
{
Description: List of external Azure storage account identifiers. ,
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 ,
}
,
}
WebApps_UpdateSlotConfigurationNames (new)
Description :  Description for Updates the names of application settings and connection string that remain with the slot during swap operation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slotConfigNames:
{
Description: Names of application settings and connection strings. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
connectionStringNames:
{
Description: List of connection string names. ,
Required: False ,
}
[
string ,
]
,
appSettingNames:
{
Description: List of application settings names. ,
Required: False ,
}
[
string ,
]
,
azureStorageConfigNames:
{
Description: List of external Azure storage account identifiers. ,
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 ,
}
{
connectionStringNames:
{
Description: List of connection string names. ,
Required: False ,
}
[
string ,
]
,
appSettingNames:
{
Description: List of application settings names. ,
Required: False ,
}
[
string ,
]
,
azureStorageConfigNames:
{
Description: List of external Azure storage account identifiers. ,
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 ,
}
,
}
WebApps_GetConfiguration (new)
Description :  Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 ,
}
{
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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateConfiguration (new)
Description :  Description for Updates the configuration of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
siteConfig:
{
Description: JSON representation of a SiteConfig object. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
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 ,
}
,
}
,
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 ,
}
{
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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateConfiguration (new)
Description :  Description for Updates the configuration of an app.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
siteConfig:
{
Description: JSON representation of a SiteConfig object. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
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 ,
}
,
}
,
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 ,
}
{
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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListConfigurationSnapshotInfo (new)
Description :  Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: SiteConfigurationSnapshotInfo resource specific properties ,
Required: False ,
}
{
time:
{
Description: The time the snapshot was taken. ,
Format: date-time ,
Required: False ,
}
string ,
snapshotId:
{
Description: The id of the snapshot ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_GetConfigurationSnapshot (new)
Description :  Description for Gets a snapshot of the configuration of an app at a previous point in time.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
snapshotId:
{
Description: The ID of the snapshot to read. ,
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 ,
}
{
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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_RecoverSiteConfigurationSnapshot (new)
Description :  Description for Reverts the configuration of an app to a previous snapshot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
snapshotId:
{
Description: The ID of the snapshot to read. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_GetWebSiteContainerLogs (new)
Description :  Description for Gets the last lines of docker logs for the given site
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}

⚐ 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 ,
}
,
}
WebApps_GetContainerLogsZip (new)
Description :  Description for Gets the ZIP archived docker log files for the given site
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}

⚐ 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 ,
}
,
}
WebApps_ListContinuousWebJobs (new)
Description :  Description for List continuous web jobs for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
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: ContinuousWebJob resource specific properties ,
Required: False ,
}
{
status:
{
Description: Job status. ,
Enum:
{
Initializing: No description available. ,
Starting: No description available. ,
Running: No description available. ,
PendingRestart: No description available. ,
Stopped: No description available. ,
}
,
Required: False ,
}
enum ,
detailed_status:
{
Description: Detailed status. ,
Required: False ,
}
string ,
log_url:
{
Description: Log URL. ,
Required: False ,
}
string ,
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
settings:
{
Description: Job settings. ,
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 ,
}
,
}
WebApps_GetContinuousWebJob (new)
Description :  Description for Gets a continuous web job by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
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: ContinuousWebJob resource specific properties ,
Required: False ,
}
{
status:
{
Description: Job status. ,
Enum:
{
Initializing: No description available. ,
Starting: No description available. ,
Running: No description available. ,
PendingRestart: No description available. ,
Stopped: No description available. ,
}
,
Required: False ,
}
enum ,
detailed_status:
{
Description: Detailed status. ,
Required: False ,
}
string ,
log_url:
{
Description: Log URL. ,
Required: False ,
}
string ,
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
settings:
{
Description: Job settings. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteContinuousWebJob (new)
Description :  Description for Delete a continuous web job by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
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 ,
}
,
}
WebApps_StartContinuousWebJob (new)
Description :  Description for Start a continuous web job for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_StopContinuousWebJob (new)
Description :  Description for Stop a continuous web job for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_ListProductionSiteDeploymentStatuses (new)
Description :  List deployment statuses for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: CsmDeploymentStatus resource specific properties ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment operation id. ,
Required: False ,
}
string ,
status:
{
Description: Deployment build status. ,
Enum:
{
TimedOut: No description available. ,
RuntimeFailed: No description available. ,
BuildAborted: No description available. ,
BuildFailed: No description available. ,
BuildRequestReceived: No description available. ,
BuildPending: No description available. ,
BuildInProgress: No description available. ,
BuildSuccessful: No description available. ,
PostBuildRestartRequired: No description available. ,
StartPolling: No description available. ,
StartPollingWithRestart: No description available. ,
RuntimeStarting: No description available. ,
RuntimeSuccessful: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfInstancesInProgress:
{
Description: Number of site instances currently being provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesSuccessful:
{
Description: Number of site instances provisioned successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesFailed:
{
Description: Number of site instances failed to provision. ,
Format: int32 ,
Required: False ,
}
integer ,
failedInstancesLogs:
{
Description: List of URLs pointing to logs for instances which failed to provision. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: List of errors. ,
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_GetProductionSiteDeploymentStatus (new)
Description :  Gets the deployment status for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: CsmDeploymentStatus resource specific properties ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment operation id. ,
Required: False ,
}
string ,
status:
{
Description: Deployment build status. ,
Enum:
{
TimedOut: No description available. ,
RuntimeFailed: No description available. ,
BuildAborted: No description available. ,
BuildFailed: No description available. ,
BuildRequestReceived: No description available. ,
BuildPending: No description available. ,
BuildInProgress: No description available. ,
BuildSuccessful: No description available. ,
PostBuildRestartRequired: No description available. ,
StartPolling: No description available. ,
StartPollingWithRestart: No description available. ,
RuntimeStarting: No description available. ,
RuntimeSuccessful: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfInstancesInProgress:
{
Description: Number of site instances currently being provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesSuccessful:
{
Description: Number of site instances provisioned successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesFailed:
{
Description: Number of site instances failed to provision. ,
Format: int32 ,
Required: False ,
}
integer ,
failedInstancesLogs:
{
Description: List of URLs pointing to logs for instances which failed to provision. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: List of errors. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: CsmDeploymentStatus resource specific properties ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment operation id. ,
Required: False ,
}
string ,
status:
{
Description: Deployment build status. ,
Enum:
{
TimedOut: No description available. ,
RuntimeFailed: No description available. ,
BuildAborted: No description available. ,
BuildFailed: No description available. ,
BuildRequestReceived: No description available. ,
BuildPending: No description available. ,
BuildInProgress: No description available. ,
BuildSuccessful: No description available. ,
PostBuildRestartRequired: No description available. ,
StartPolling: No description available. ,
StartPollingWithRestart: No description available. ,
RuntimeStarting: No description available. ,
RuntimeSuccessful: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfInstancesInProgress:
{
Description: Number of site instances currently being provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesSuccessful:
{
Description: Number of site instances provisioned successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesFailed:
{
Description: Number of site instances failed to provision. ,
Format: int32 ,
Required: False ,
}
integer ,
failedInstancesLogs:
{
Description: List of URLs pointing to logs for instances which failed to provision. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: List of errors. ,
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListDeployments (new)
Description :  Description for List deployments for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: Deployment resource specific properties ,
Required: False ,
}
{
status:
{
Description: Deployment status. ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Details about deployment status. ,
Required: False ,
}
string ,
author:
{
Description: Who authored the deployment. ,
Required: False ,
}
string ,
deployer:
{
Description: Who performed the deployment. ,
Required: False ,
}
string ,
author_email:
{
Description: Author email. ,
Required: False ,
}
string ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: True if deployment is currently active, false if completed and null if not started. ,
Required: False ,
}
boolean ,
details:
{
Description: Details on deployment. ,
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 ,
}
,
}
WebApps_GetDeployment (new)
Description :  Description for Get a deployment by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
id:
{
Description: Deployment ID. ,
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: Deployment resource specific properties ,
Required: False ,
}
{
status:
{
Description: Deployment status. ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Details about deployment status. ,
Required: False ,
}
string ,
author:
{
Description: Who authored the deployment. ,
Required: False ,
}
string ,
deployer:
{
Description: Who performed the deployment. ,
Required: False ,
}
string ,
author_email:
{
Description: Author email. ,
Required: False ,
}
string ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: True if deployment is currently active, false if completed and null if not started. ,
Required: False ,
}
boolean ,
details:
{
Description: Details on deployment. ,
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 ,
}
,
}
WebApps_CreateDeployment (new)
Description :  Description for Create a deployment for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
id:
{
Description: ID of an existing deployment. ,
Required: True ,
}
string ,
deployment:
{
Description: Deployment details. ,
Required: True ,
}
{
properties:
{
Description: Deployment resource specific properties ,
Required: False ,
}
{
status:
{
Description: Deployment status. ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Details about deployment status. ,
Required: False ,
}
string ,
author:
{
Description: Who authored the deployment. ,
Required: False ,
}
string ,
deployer:
{
Description: Who performed the deployment. ,
Required: False ,
}
string ,
author_email:
{
Description: Author email. ,
Required: False ,
}
string ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: True if deployment is currently active, false if completed and null if not started. ,
Required: False ,
}
boolean ,
details:
{
Description: Details on deployment. ,
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: Deployment resource specific properties ,
Required: False ,
}
{
status:
{
Description: Deployment status. ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Details about deployment status. ,
Required: False ,
}
string ,
author:
{
Description: Who authored the deployment. ,
Required: False ,
}
string ,
deployer:
{
Description: Who performed the deployment. ,
Required: False ,
}
string ,
author_email:
{
Description: Author email. ,
Required: False ,
}
string ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: True if deployment is currently active, false if completed and null if not started. ,
Required: False ,
}
boolean ,
details:
{
Description: Details on deployment. ,
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 ,
}
,
}
WebApps_DeleteDeployment (new)
Description :  Description for Delete a deployment by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
id:
{
Description: Deployment ID. ,
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 ,
}
,
}
WebApps_ListDeploymentLog (new)
Description :  Description for List deployment log for specific deployment for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
id:
{
Description: The ID of a specific deployment. This is the value of the name property in the JSON response from "GET /api/sites/{siteName}/deployments". ,
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: Deployment resource specific properties ,
Required: False ,
}
{
status:
{
Description: Deployment status. ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Details about deployment status. ,
Required: False ,
}
string ,
author:
{
Description: Who authored the deployment. ,
Required: False ,
}
string ,
deployer:
{
Description: Who performed the deployment. ,
Required: False ,
}
string ,
author_email:
{
Description: Author email. ,
Required: False ,
}
string ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: True if deployment is currently active, false if completed and null if not started. ,
Required: False ,
}
boolean ,
details:
{
Description: Details on deployment. ,
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 ,
}
,
}
WebApps_DiscoverBackup (new)
Description :  Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/discoverbackup
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
request:
{
Description: A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup. ,
Required: True ,
}
{
properties:
{
Description: RestoreRequest resource specific properties ,
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup. ,
Required: False ,
}
string ,
overwrite:
{
Description: true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. ,
Required: True ,
}
boolean ,
siteName:
{
Description: Name of an app. ,
Required: False ,
}
string ,
databases:
{
Description: Collection of databases which should be restored. This list has to match the list of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
ignoreConflictingHostNames:
{
Description: Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
ignoreDatabases:
{
Description: Ignore the databases and only restore the site content ,
Required: False ,
}
boolean ,
appServicePlan:
{
Description: Specify app service plan that will own restored site. ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
Snapshot: No description available. ,
CloudFS: No description available. ,
}
,
Required: False ,
}
enum ,
adjustConnectionStrings:
{
Description: true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false. ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring an app to an App Service Environment). ,
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: RestoreRequest resource specific properties ,
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup. ,
Required: False ,
}
string ,
overwrite:
{
Description: true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. ,
Required: True ,
}
boolean ,
siteName:
{
Description: Name of an app. ,
Required: False ,
}
string ,
databases:
{
Description: Collection of databases which should be restored. This list has to match the list of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
ignoreConflictingHostNames:
{
Description: Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
ignoreDatabases:
{
Description: Ignore the databases and only restore the site content ,
Required: False ,
}
boolean ,
appServicePlan:
{
Description: Specify app service plan that will own restored site. ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
Snapshot: No description available. ,
CloudFS: No description available. ,
}
,
Required: False ,
}
enum ,
adjustConnectionStrings:
{
Description: true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false. ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring an app to an App Service Environment). ,
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 ,
}
,
}
WebApps_ListDomainOwnershipIdentifiers (new)
Description :  Description for Lists ownership identifiers for domain associated with web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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 ,
}
,
}
WebApps_GetDomainOwnershipIdentifier (new)
Description :  Description for Get domain ownership identifier for web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
domainOwnershipIdentifierName:
{
Description: Name of domain ownership identifier. ,
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: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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 ,
}
,
}
WebApps_CreateOrUpdateDomainOwnershipIdentifier (new)
Description :  Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
domainOwnershipIdentifierName:
{
Description: Name of domain ownership identifier. ,
Required: True ,
}
string ,
domainOwnershipIdentifier:
{
Description: A JSON representation of the domain ownership properties. ,
Required: True ,
}
{
properties:
{
Description: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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 ,
}
,
}
WebApps_DeleteDomainOwnershipIdentifier (new)
Description :  Description for Deletes a domain ownership identifier for a web app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
domainOwnershipIdentifierName:
{
Description: Name of domain ownership identifier. ,
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 ,
}
,
}
WebApps_UpdateDomainOwnershipIdentifier (new)
Description :  Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
domainOwnershipIdentifierName:
{
Description: Name of domain ownership identifier. ,
Required: True ,
}
string ,
domainOwnershipIdentifier:
{
Description: A JSON representation of the domain ownership properties. ,
Required: True ,
}
{
properties:
{
Description: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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 ,
}
,
}
WebApps_GetMSDeployStatus (new)
Description :  Description for Get the status of the last MSDeploy operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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: MSDeployStatus resource specific properties ,
Required: False ,
}
{
deployer:
{
Description: Username of deployer ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
accepted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
complete:
{
Description: Whether the deployment operation has completed ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateMSDeployOperation (new)
Description :  Description for Invoke the MSDeploy web app extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
MSDeploy:
{
Description: Details of MSDeploy operation ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
addOnPackages:
{
Description: List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule. ,
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 (201)

{
properties:
{
Description: MSDeployStatus resource specific properties ,
Required: False ,
}
{
deployer:
{
Description: Username of deployer ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
accepted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
complete:
{
Description: Whether the deployment operation has completed ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (409)

{}

⚐ 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 ,
}
,
}
WebApps_GetMSDeployLog (new)
Description :  Description for Get the MSDeploy Log for the last MSDeploy operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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: MSDeployLog resource specific properties ,
Required: False ,
}
{
entries:
{
Description: List of log entry messages ,
Required: False ,
}
[
{
time:
{
Description: Timestamp of log entry ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Log entry type ,
Enum:
{
Message: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Log entry message ,
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 ,
}
,
}
WebApps_GetOneDeployStatus (new)
Description :  Description for Invoke onedeploy status API /api/deployments and gets the deployment status for the site
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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 (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 ,
}
,
}
WebApps_CreateOneDeployOperation (new)
Description :  Description for Invoke the OneDeploy publish web app extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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 (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 ,
}
,
}
WebApps_ListFunctions (new)
Description :  Description for List the functions for a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
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: FunctionEnvelope resource specific properties ,
Required: False ,
}
{
function_app_id:
{
Description: Function App ID. ,
Required: False ,
}
string ,
script_root_path_href:
{
Description: Script root path URI. ,
Required: False ,
}
string ,
script_href:
{
Description: Script URI. ,
Required: False ,
}
string ,
config_href:
{
Description: Config URI. ,
Required: False ,
}
string ,
test_data_href:
{
Description: Test data URI. ,
Required: False ,
}
string ,
secrets_file_href:
{
Description: Secrets file URI. ,
Required: False ,
}
string ,
href:
{
Description: Function URI. ,
Required: False ,
}
string ,
config:
{
Description: Config information. ,
Required: False ,
}
object ,
files:
{
Description: File list. ,
Required: False ,
}
object ,
test_data:
{
Description: Test data used when testing via the Azure Portal. ,
Required: False ,
}
string ,
invoke_url_template:
{
Description: The invocation URL ,
Required: False ,
}
string ,
language:
{
Description: The function language ,
Required: False ,
}
string ,
isDisabled:
{
Description: Gets or sets a value indicating whether the function is disabled ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetFunctionsAdminToken (new)
Description :  Description for Fetch a short lived token that can be exchanged for a master key.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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: 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 ,
}
,
}
WebApps_GetFunction (new)
Description :  Description for Get function information by its ID for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: Function name. ,
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: FunctionEnvelope resource specific properties ,
Required: False ,
}
{
function_app_id:
{
Description: Function App ID. ,
Required: False ,
}
string ,
script_root_path_href:
{
Description: Script root path URI. ,
Required: False ,
}
string ,
script_href:
{
Description: Script URI. ,
Required: False ,
}
string ,
config_href:
{
Description: Config URI. ,
Required: False ,
}
string ,
test_data_href:
{
Description: Test data URI. ,
Required: False ,
}
string ,
secrets_file_href:
{
Description: Secrets file URI. ,
Required: False ,
}
string ,
href:
{
Description: Function URI. ,
Required: False ,
}
string ,
config:
{
Description: Config information. ,
Required: False ,
}
object ,
files:
{
Description: File list. ,
Required: False ,
}
object ,
test_data:
{
Description: Test data used when testing via the Azure Portal. ,
Required: False ,
}
string ,
invoke_url_template:
{
Description: The invocation URL ,
Required: False ,
}
string ,
language:
{
Description: The function language ,
Required: False ,
}
string ,
isDisabled:
{
Description: Gets or sets a value indicating whether the function is disabled ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateFunction (new)
Description :  Description for Create function for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: Function name. ,
Required: True ,
}
string ,
function_envelope:
{
Description: Function details. ,
Required: True ,
}
{
properties:
{
Description: FunctionEnvelope resource specific properties ,
Required: False ,
}
{
function_app_id:
{
Description: Function App ID. ,
Required: False ,
}
string ,
script_root_path_href:
{
Description: Script root path URI. ,
Required: False ,
}
string ,
script_href:
{
Description: Script URI. ,
Required: False ,
}
string ,
config_href:
{
Description: Config URI. ,
Required: False ,
}
string ,
test_data_href:
{
Description: Test data URI. ,
Required: False ,
}
string ,
secrets_file_href:
{
Description: Secrets file URI. ,
Required: False ,
}
string ,
href:
{
Description: Function URI. ,
Required: False ,
}
string ,
config:
{
Description: Config information. ,
Required: False ,
}
object ,
files:
{
Description: File list. ,
Required: False ,
}
object ,
test_data:
{
Description: Test data used when testing via the Azure Portal. ,
Required: False ,
}
string ,
invoke_url_template:
{
Description: The invocation URL ,
Required: False ,
}
string ,
language:
{
Description: The function language ,
Required: False ,
}
string ,
isDisabled:
{
Description: Gets or sets a value indicating whether the function is disabled ,
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 (201)

{
properties:
{
Description: FunctionEnvelope resource specific properties ,
Required: False ,
}
{
function_app_id:
{
Description: Function App ID. ,
Required: False ,
}
string ,
script_root_path_href:
{
Description: Script root path URI. ,
Required: False ,
}
string ,
script_href:
{
Description: Script URI. ,
Required: False ,
}
string ,
config_href:
{
Description: Config URI. ,
Required: False ,
}
string ,
test_data_href:
{
Description: Test data URI. ,
Required: False ,
}
string ,
secrets_file_href:
{
Description: Secrets file URI. ,
Required: False ,
}
string ,
href:
{
Description: Function URI. ,
Required: False ,
}
string ,
config:
{
Description: Config information. ,
Required: False ,
}
object ,
files:
{
Description: File list. ,
Required: False ,
}
object ,
test_data:
{
Description: Test data used when testing via the Azure Portal. ,
Required: False ,
}
string ,
invoke_url_template:
{
Description: The invocation URL ,
Required: False ,
}
string ,
language:
{
Description: The function language ,
Required: False ,
}
string ,
isDisabled:
{
Description: Gets or sets a value indicating whether the function is disabled ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteFunction (new)
Description :  Description for Delete a function for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateFunctionSecret (new)
Description :  Description for Add or update a function secret.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/keys/{keyName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: The name of the function. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key. ,
Required: True ,
}
string ,
key:
{
Description: The key to create or update ,
Required: True ,
}
{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
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 (201)

{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
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 ,
}
,
}
WebApps_DeleteFunctionSecret (new)
Description :  Description for Delete a function secret.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/keys/{keyName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: The name of the function. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key. ,
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 (404)

{}

⚐ 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 ,
}
,
}
WebApps_ListFunctionKeys (new)
Description :  Description for Get function keys for a function in a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listkeys
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: Function name. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListFunctionSecrets (new)
Description :  Description for Get function secrets for a function in a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: Function name. ,
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)

{
key:
{
Description: Secret key. ,
Required: False ,
}
string ,
trigger_url:
{
Description: Trigger URL. ,
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 ,
}
,
}
WebApps_ListHostKeys (new)
Description :  Description for Get host secrets for a function app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
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)

{
masterKey:
{
Description: Secret key. ,
Required: False ,
}
string ,
functionKeys:
{
Description: Host level function keys. ,
Required: False ,
}
object ,
systemKeys:
{
Description: System keys. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListSyncStatus (new)
Description :  Description for This is to allow calling via powershell and ARM template.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_SyncFunctions (new)
Description :  Description for Syncs function trigger metadata to the management database
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateHostSecret (new)
Description :  Description for Add or update a host level secret.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
keyType:
{
Description: The type of host key. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key. ,
Required: True ,
}
string ,
key:
{
Description: The key to create or update ,
Required: True ,
}
{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
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 (201)

{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
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 ,
}
,
}
WebApps_DeleteHostSecret (new)
Description :  Description for Delete a host level secret.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
keyType:
{
Description: The type of host key. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key. ,
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 (404)

{}

⚐ 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 ,
}
,
}
WebApps_ListHostNameBindings (new)
Description :  Description for Get hostname bindings for an app or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: HostNameBinding resource specific properties ,
Required: False ,
}
{
siteName:
{
Description: App Service app name. ,
Required: False ,
}
string ,
domainId:
{
Description: Fully qualified ARM domain resource URI. ,
Required: False ,
}
string ,
azureResourceName:
{
Description: Azure resource name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Azure resource type. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Custom DNS record type. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Hostname type. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: SSL certificate thumbprint ,
Required: False ,
}
string ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
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 ,
}
,
}
WebApps_GetHostNameBinding (new)
Description :  Description for Get the named hostname binding for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
hostName:
{
Description: Hostname in the hostname binding. ,
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: HostNameBinding resource specific properties ,
Required: False ,
}
{
siteName:
{
Description: App Service app name. ,
Required: False ,
}
string ,
domainId:
{
Description: Fully qualified ARM domain resource URI. ,
Required: False ,
}
string ,
azureResourceName:
{
Description: Azure resource name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Azure resource type. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Custom DNS record type. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Hostname type. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: SSL certificate thumbprint ,
Required: False ,
}
string ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
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 ,
}
,
}
WebApps_CreateOrUpdateHostNameBinding (new)
Description :  Description for Creates a hostname binding for an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
hostName:
{
Description: Hostname in the hostname binding. ,
Required: True ,
}
string ,
hostNameBinding:
{
Description: Binding details. This is the JSON representation of a HostNameBinding object. ,
Required: True ,
}
{
properties:
{
Description: HostNameBinding resource specific properties ,
Required: False ,
}
{
siteName:
{
Description: App Service app name. ,
Required: False ,
}
string ,
domainId:
{
Description: Fully qualified ARM domain resource URI. ,
Required: False ,
}
string ,
azureResourceName:
{
Description: Azure resource name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Azure resource type. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Custom DNS record type. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Hostname type. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: SSL certificate thumbprint ,
Required: False ,
}
string ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
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: HostNameBinding resource specific properties ,
Required: False ,
}
{
siteName:
{
Description: App Service app name. ,
Required: False ,
}
string ,
domainId:
{
Description: Fully qualified ARM domain resource URI. ,
Required: False ,
}
string ,
azureResourceName:
{
Description: Azure resource name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Azure resource type. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Custom DNS record type. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Hostname type. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: SSL certificate thumbprint ,
Required: False ,
}
string ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
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 ,
}
,
}
WebApps_DeleteHostNameBinding (new)
Description :  Description for Deletes a hostname binding for an app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
hostName:
{
Description: Hostname in the hostname binding. ,
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 ,
}
,
}
WebApps_GetHybridConnection (new)
Description :  Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace for this hybrid connection. ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name for this hybrid 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: 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 ,
}
,
}
WebApps_CreateOrUpdateHybridConnection (new)
Description :  Description for Creates a new Hybrid Connection using a Service Bus relay.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace for this hybrid connection. ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name for this hybrid connection. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the hybrid connection. ,
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 ,
}
,
}
,
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 ,
}
,
}
WebApps_DeleteHybridConnection (new)
Description :  Description for Removes a Hybrid Connection from this site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace for this hybrid connection. ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name for this hybrid 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)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateHybridConnection (new)
Description :  Description for Creates a new Hybrid Connection using a Service Bus relay.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace for this hybrid connection. ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name for this hybrid connection. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the hybrid connection. ,
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 ,
}
,
}
,
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 ,
}
,
}
WebApps_ListHybridConnections (new)
Description :  Description for Retrieves all Service Bus Hybrid Connections used by this Web App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
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 ,
}
,
}
WebApps_ListRelayServiceConnections (new)
Description :  Description for Gets hybrid connections configured for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
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 ,
}
,
}
WebApps_GetRelayServiceConnection (new)
Description :  Description for Gets a hybrid connection configuration by its name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
entityName:
{
Description: Name of the hybrid 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: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
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 ,
}
,
}
WebApps_CreateOrUpdateRelayServiceConnection (new)
Description :  Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
entityName:
{
Description: Name of the hybrid connection configuration. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Details of the hybrid connection configuration. ,
Required: True ,
}
{
properties:
{
Description: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
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: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
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 ,
}
,
}
WebApps_DeleteRelayServiceConnection (new)
Description :  Description for Deletes a relay service connection by its name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateRelayServiceConnection (new)
Description :  Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
entityName:
{
Description: Name of the hybrid connection configuration. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Details of the hybrid connection configuration. ,
Required: True ,
}
{
properties:
{
Description: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
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: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
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 ,
}
,
}
WebApps_ListInstanceIdentifiers (new)
Description :  Description for Gets all scale-out instances of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: WebSiteInstanceStatus resource specific properties ,
Required: False ,
}
{
state:
{
Enum:
{
READY: No description available. ,
STOPPED: No description available. ,
UNKNOWN: No description available. ,
}
,
Required: False ,
}
enum ,
statusUrl:
{
Description: Link to the GetStatusApi in Kudu ,
Required: False ,
}
string ,
detectorUrl:
{
Description: Link to the Diagnose and Solve Portal ,
Required: False ,
}
string ,
consoleUrl:
{
Description: Link to the console to web app instance ,
Required: False ,
}
string ,
healthCheckUrl:
{
Description: Link to the console to web app instance ,
Required: False ,
}
string ,
containers:
{
Required: False ,
}
object ,
physicalZone:
{
Description: The physical zone that the instance is in ,
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 ,
}
,
}
WebApps_GetInstanceInfo (new)
Description :  Description for Gets all scale-out instances of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
instanceId:
{
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: WebSiteInstanceStatus resource specific properties ,
Required: False ,
}
{
state:
{
Enum:
{
READY: No description available. ,
STOPPED: No description available. ,
UNKNOWN: No description available. ,
}
,
Required: False ,
}
enum ,
statusUrl:
{
Description: Link to the GetStatusApi in Kudu ,
Required: False ,
}
string ,
detectorUrl:
{
Description: Link to the Diagnose and Solve Portal ,
Required: False ,
}
string ,
consoleUrl:
{
Description: Link to the console to web app instance ,
Required: False ,
}
string ,
healthCheckUrl:
{
Description: Link to the console to web app instance ,
Required: False ,
}
string ,
containers:
{
Required: False ,
}
object ,
physicalZone:
{
Description: The physical zone that the instance is in ,
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 ,
}
,
}
WebApps_GetInstanceMsDeployStatus (new)
Description :  Description for Get the status of the last MSDeploy operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of web app instance. ,
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: MSDeployStatus resource specific properties ,
Required: False ,
}
{
deployer:
{
Description: Username of deployer ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
accepted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
complete:
{
Description: Whether the deployment operation has completed ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateInstanceMSDeployOperation (new)
Description :  Description for Invoke the MSDeploy web app extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of web app instance. ,
Required: True ,
}
string ,
MSDeploy:
{
Description: Details of MSDeploy operation ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
addOnPackages:
{
Description: List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule. ,
Required: False ,
}
[
{
packageUri:
{
Description: Package URI ,
Required: False ,
}
string ,
connectionString:
{
Description: SQL Connection String ,
Required: False ,
}
string ,
dbType:
{
Description: Database Type ,
Required: False ,
}
string ,
setParametersXmlFileUri:
{
Description: URI of MSDeploy Parameters file. Must not be set if SetParameters is used. ,
Required: False ,
}
string ,
setParameters:
{
Description: MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. ,
Required: False ,
}
object ,
skipAppData:
{
Description: Controls whether the MSDeploy operation skips the App_Data directory. If set to true, the existing App_Data directory on the destination will not be deleted, and any App_Data directory in the source will be ignored. Setting is false by default. ,
Required: False ,
}
boolean ,
appOffline:
{
Description: Sets the AppOffline rule while the MSDeploy operation executes. Setting is false by default. ,
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 (201)

{
properties:
{
Description: MSDeployStatus resource specific properties ,
Required: False ,
}
{
deployer:
{
Description: Username of deployer ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
accepted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
complete:
{
Description: Whether the deployment operation has completed ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (409)

{}

⚐ 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 ,
}
,
}
WebApps_GetInstanceMSDeployLog (new)
Description :  Description for Get the MSDeploy Log for the last MSDeploy operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of web app instance. ,
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: MSDeployLog resource specific properties ,
Required: False ,
}
{
entries:
{
Description: List of log entry messages ,
Required: False ,
}
[
{
time:
{
Description: Timestamp of log entry ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Log entry type ,
Enum:
{
Message: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Log entry message ,
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 ,
}
,
}
WebApps_ListInstanceProcesses (new)
Description :  Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: ProcessInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: ARM Identifier for deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
deployment_name:
{
Description: Deployment name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
minidump:
{
Description: Minidump URI. ,
Required: False ,
}
string ,
is_profile_running:
{
Description: Is profile running? ,
Required: False ,
}
boolean ,
is_iis_profile_running:
{
Description: Is the IIS Profile running? ,
Required: False ,
}
boolean ,
iis_profile_timeout_in_seconds:
{
Description: IIS Profile timeout (seconds). ,
Format: double ,
Required: False ,
}
number ,
parent:
{
Description: Parent process. ,
Required: False ,
}
string ,
children:
{
Description: Child process list. ,
Required: False ,
}
[
string ,
]
,
threads:
{
Description: Thread list. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
open_file_handles:
{
Description: List of open files. ,
Required: False ,
}
[
string ,
]
,
modules:
{
Description: List of modules. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
file_name:
{
Description: File name of this process. ,
Required: False ,
}
string ,
command_line:
{
Description: Command line. ,
Required: False ,
}
string ,
user_name:
{
Description: User name. ,
Required: False ,
}
string ,
handle_count:
{
Description: Handle count. ,
Format: int32 ,
Required: False ,
}
integer ,
module_count:
{
Description: Module count. ,
Format: int32 ,
Required: False ,
}
integer ,
thread_count:
{
Description: Thread count. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_cpu_time:
{
Description: Total CPU time. ,
Required: False ,
}
string ,
user_cpu_time:
{
Description: User CPU time. ,
Required: False ,
}
string ,
privileged_cpu_time:
{
Description: Privileged CPU time. ,
Required: False ,
}
string ,
working_set:
{
Description: Working set. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_working_set:
{
Description: Peak working set. ,
Format: int64 ,
Required: False ,
}
integer ,
private_memory:
{
Description: Private memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
virtual_memory:
{
Description: Virtual memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_virtual_memory:
{
Description: Peak virtual memory usage. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_system_memory:
{
Description: Paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
non_paged_system_memory:
{
Description: Non-paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_memory:
{
Description: Paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_paged_memory:
{
Description: Peak paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
time_stamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
environment_variables:
{
Description: List of environment variables. ,
Required: False ,
}
object ,
is_scm_site:
{
Description: Is this the SCM site? ,
Required: False ,
}
boolean ,
is_webjob:
{
Description: Is this a Web Job? ,
Required: False ,
}
boolean ,
description:
{
Description: Description of process. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetInstanceProcess (new)
Description :  Description for Get process information by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: ProcessInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: ARM Identifier for deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
deployment_name:
{
Description: Deployment name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
minidump:
{
Description: Minidump URI. ,
Required: False ,
}
string ,
is_profile_running:
{
Description: Is profile running? ,
Required: False ,
}
boolean ,
is_iis_profile_running:
{
Description: Is the IIS Profile running? ,
Required: False ,
}
boolean ,
iis_profile_timeout_in_seconds:
{
Description: IIS Profile timeout (seconds). ,
Format: double ,
Required: False ,
}
number ,
parent:
{
Description: Parent process. ,
Required: False ,
}
string ,
children:
{
Description: Child process list. ,
Required: False ,
}
[
string ,
]
,
threads:
{
Description: Thread list. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
open_file_handles:
{
Description: List of open files. ,
Required: False ,
}
[
string ,
]
,
modules:
{
Description: List of modules. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
file_name:
{
Description: File name of this process. ,
Required: False ,
}
string ,
command_line:
{
Description: Command line. ,
Required: False ,
}
string ,
user_name:
{
Description: User name. ,
Required: False ,
}
string ,
handle_count:
{
Description: Handle count. ,
Format: int32 ,
Required: False ,
}
integer ,
module_count:
{
Description: Module count. ,
Format: int32 ,
Required: False ,
}
integer ,
thread_count:
{
Description: Thread count. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_cpu_time:
{
Description: Total CPU time. ,
Required: False ,
}
string ,
user_cpu_time:
{
Description: User CPU time. ,
Required: False ,
}
string ,
privileged_cpu_time:
{
Description: Privileged CPU time. ,
Required: False ,
}
string ,
working_set:
{
Description: Working set. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_working_set:
{
Description: Peak working set. ,
Format: int64 ,
Required: False ,
}
integer ,
private_memory:
{
Description: Private memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
virtual_memory:
{
Description: Virtual memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_virtual_memory:
{
Description: Peak virtual memory usage. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_system_memory:
{
Description: Paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
non_paged_system_memory:
{
Description: Non-paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_memory:
{
Description: Paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_paged_memory:
{
Description: Peak paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
time_stamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
environment_variables:
{
Description: List of environment variables. ,
Required: False ,
}
object ,
is_scm_site:
{
Description: Is this the SCM site? ,
Required: False ,
}
boolean ,
is_webjob:
{
Description: Is this a Web Job? ,
Required: False ,
}
boolean ,
description:
{
Description: Description of process. ,
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 ,
}
,
}
WebApps_DeleteInstanceProcess (new)
Description :  Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_GetInstanceProcessDump (new)
Description :  Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: file ,
}

⚐ 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 ,
}
,
}
WebApps_ListInstanceProcessModules (new)
Description :  Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetInstanceProcessModule (new)
Description :  Description for Get process information by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
baseAddress:
{
Description: Module base address. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
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 ,
}
,
}
WebApps_ListInstanceProcessThreads (new)
Description :  Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_IsCloneable (new)
Description :  Description for Shows whether an app can be cloned to another resource group or subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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)

{
result:
{
Description: Name of app. ,
Enum:
{
Cloneable: No description available. ,
PartiallyCloneable: No description available. ,
NotCloneable: No description available. ,
}
,
Required: False ,
}
enum ,
blockingFeatures:
{
Description: List of features enabled on app that prevent cloning. ,
Required: False ,
}
[
{
name:
{
Description: Name of criterion. ,
Required: False ,
}
string ,
description:
{
Description: Description of criterion. ,
Required: False ,
}
string ,
}
,
]
,
unsupportedFeatures:
{
Description: List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned but the features in this list will not be set up on cloned app. ,
Required: False ,
}
[
{
name:
{
Description: Name of criterion. ,
Required: False ,
}
string ,
description:
{
Description: Description of criterion. ,
Required: False ,
}
string ,
}
,
]
,
blockingCharacteristics:
{
Description: List of blocking application characteristics. ,
Required: False ,
}
[
{
name:
{
Description: Name of criterion. ,
Required: False ,
}
string ,
description:
{
Description: Description of criterion. ,
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 ,
}
,
}
WebApps_ListSiteBackups (new)
Description :  Description for Gets existing backups of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listbackups
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: BackupItem resource specific properties ,
Required: False ,
}
{
id:
{
Description: Id of the backup. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: SAS URL for the storage account container which contains this backup. ,
Required: False ,
}
string ,
blobName:
{
Description: Name of the blob which contains data for this backup. ,
Required: False ,
}
string ,
name:
{
Description: Name of this backup. ,
Required: False ,
}
string ,
status:
{
Description: Backup status. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
Skipped: No description available. ,
PartiallySucceeded: No description available. ,
DeleteInProgress: No description available. ,
DeleteFailed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: Size of the backup in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: Timestamp of the backup creation. ,
Format: date-time ,
Required: False ,
}
string ,
log:
{
Description: Details regarding this backup. Might contain an error message. ,
Required: False ,
}
string ,
databases:
{
Description: List of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
scheduled:
{
Description: True if this backup has been created due to a schedule being triggered. ,
Required: False ,
}
boolean ,
lastRestoreTimeStamp:
{
Description: Timestamp of a last restore operation which used this backup. ,
Format: date-time ,
Required: False ,
}
string ,
finishedTimeStamp:
{
Description: Timestamp when this backup finished. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. ,
Required: False ,
}
string ,
websiteSizeInBytes:
{
Description: Size of the original web app which has been backed up. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_ListSyncFunctionTriggers (new)
Description :  Description for This is to allow calling via powershell and ARM template.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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)

{
key:
{
Description: Secret key. ,
Required: False ,
}
string ,
trigger_url:
{
Description: Trigger URL. ,
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 ,
}
,
}
WebApps_UpdateMachineKey (new)
Description :  Updates the machine key of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/updatemachinekey
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 (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 ,
}
,
}
WebApps_MigrateStorage (new)
Description :  Description for Restores a web app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate
{
subscriptionName:
{
Description: Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
migrationOptions:
{
Description: Migration migrationOptions. ,
Required: True ,
}
{
properties:
{
Description: StorageMigrationOptions resource specific properties ,
Required: False ,
}
{
azurefilesConnectionString:
{
Description: AzureFiles connection string. ,
Required: True ,
}
string ,
azurefilesShare:
{
Description: AzureFiles share. ,
Required: True ,
}
string ,
switchSiteAfterMigration:
{
Description: trueif the app should be switched over; otherwise, false. ,
Required: False ,
}
boolean ,
blockWriteAccessToSite:
{
Description: true if the app should be read only during copy operation; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: StorageMigrationResponse resource specific properties ,
Required: False ,
}
{
operationId:
{
Description: When server starts the migration process, it will return an operation ID identifying that particular migration operation. ,
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 ,
}
,
}
WebApps_MigrateMySql (new)
Description :  Description for Migrates a local (in-app) MySql database to a remote MySql database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
migrationRequestEnvelope:
{
Description: MySql migration options. ,
Required: True ,
}
{
properties:
{
Description: MigrateMySqlRequest resource specific properties ,
Required: False ,
}
{
connectionString:
{
Description: Connection string to the remote MySQL database. ,
Required: True ,
}
string ,
migrationType:
{
Description: The type of migration operation to be done ,
Enum:
{
LocalToRemote: No description available. ,
RemoteToLocal: No description available. ,
}
,
Required: True ,
}
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)

{
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 ,
}
,
}
WebApps_GetMigrateMySqlStatus (new)
Description :  Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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: MigrateMySqlStatus resource specific properties ,
Required: False ,
}
{
migrationOperationStatus:
{
Description: Status of the migration task. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
operationId:
{
Description: Operation ID for the migration task. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: True if the web app has in app MySql enabled ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_GetSwiftVirtualNetworkConnection (new)
Description :  Description for Gets a Swift Virtual Network connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: SwiftVirtualNetwork resource specific properties ,
Required: False ,
}
{
subnetResourceId:
{
Description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. ,
Required: False ,
}
string ,
swiftSupported:
{
Description: A flag that specifies if the scale unit this Web App is on supports Swift integration. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionWithCheck (new)
Description :  Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Properties of the Virtual Network connection. See example. ,
Required: True ,
}
{
properties:
{
Description: SwiftVirtualNetwork resource specific properties ,
Required: False ,
}
{
subnetResourceId:
{
Description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. ,
Required: False ,
}
string ,
swiftSupported:
{
Description: A flag that specifies if the scale unit this Web App is on supports Swift integration. ,
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)

{
properties:
{
Description: SwiftVirtualNetwork resource specific properties ,
Required: False ,
}
{
subnetResourceId:
{
Description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. ,
Required: False ,
}
string ,
swiftSupported:
{
Description: A flag that specifies if the scale unit this Web App is on supports Swift integration. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteSwiftVirtualNetwork (new)
Description :  Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateSwiftVirtualNetworkConnectionWithCheck (new)
Description :  Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Properties of the Virtual Network connection. See example. ,
Required: True ,
}
{
properties:
{
Description: SwiftVirtualNetwork resource specific properties ,
Required: False ,
}
{
subnetResourceId:
{
Description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. ,
Required: False ,
}
string ,
swiftSupported:
{
Description: A flag that specifies if the scale unit this Web App is on supports Swift integration. ,
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)

{
properties:
{
Description: SwiftVirtualNetwork resource specific properties ,
Required: False ,
}
{
subnetResourceId:
{
Description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. ,
Required: False ,
}
string ,
swiftSupported:
{
Description: A flag that specifies if the scale unit this Web App is on supports Swift integration. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListNetworkFeatures (new)
Description :  Description for Gets all network features used by the app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
view:
{
Description: The type of view. Only "summary" is supported at this time. ,
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: NetworkFeatures resource specific properties ,
Required: False ,
}
{
virtualNetworkName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
virtualNetworkConnection:
{
Description: The Virtual Network summary view. ,
Required: False ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
Required: False ,
}
boolean ,
}
,
hybridConnections:
{
Description: The Hybrid Connections summary view. ,
Required: False ,
}
[
{
properties:
{
Description: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
Required: False ,
}
string ,
}
,
}
,
]
,
hybridConnectionsV2:
{
Description: The Hybrid Connection V2 (Service Bus) view. ,
Required: False ,
}
[
{
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 (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 ,
}
,
}
WebApps_GetNetworkTraceOperation (new)
Description :  Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
operationId:
{
Description: GUID of the operation. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_StartWebSiteNetworkTrace (new)
Description :  Description for Start capturing network packets for the site (To be deprecated).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
durationInSeconds:
{
Description: The duration to keep capturing in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFrameLength:
{
Description: The maximum frame length in bytes (Optional). ,
Format: int32 ,
Required: False ,
}
integer ,
sasUrl:
{
Description: The Blob URL to store capture file. ,
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)

{
$schema: 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 ,
}
,
}
WebApps_StartWebSiteNetworkTraceOperation (new)
Description :  Description for Start capturing network packets for the site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
durationInSeconds:
{
Description: The duration to keep capturing in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFrameLength:
{
Description: The maximum frame length in bytes (Optional). ,
Format: int32 ,
Required: False ,
}
integer ,
sasUrl:
{
Description: The Blob URL to store capture file. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_StopWebSiteNetworkTrace (new)
Description :  Description for Stop ongoing capturing network packets for the site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
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 ,
}
,
}
WebApps_GetNetworkTraces (new)
Description :  Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
operationId:
{
Description: GUID of the operation. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_GetNetworkTraceOperationV2 (new)
Description :  Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
operationId:
{
Description: GUID of the operation. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_GetNetworkTracesV2 (new)
Description :  Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
operationId:
{
Description: GUID of the operation. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_GenerateNewSitePublishingPassword (new)
Description :  Description for Generates a new publishing password for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 ,
}
,
}
WebApps_ListPerfMonCounters (new)
Description :  Description for Gets perfmon counters for web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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=(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 ,
}
[
{
code:
{
Description: The response code. ,
Required: False ,
}
string ,
message:
{
Description: The message. ,
Required: False ,
}
string ,
data:
{
Description: The performance monitor counters. ,
Required: False ,
}
{
name:
{
Description: Unique key name of the counter. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the period. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the period. ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Presented time grain. ,
Required: False ,
}
string ,
values:
{
Description: Collection of workers that are active during this time. ,
Required: False ,
}
[
{
time:
{
Description: Point in time for which counter was measured. ,
Format: date-time ,
Required: False ,
}
string ,
instanceName:
{
Description: Name of the server on which the measurement is made. ,
Required: False ,
}
string ,
value:
{
Description: Value of counter at a certain time. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_GetSitePhpErrorLogFlag (new)
Description :  Description for Gets web app's event logs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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: SitePhpErrorLogFlag resource specific properties ,
Required: False ,
}
{
localLogErrors:
{
Description: Local log_errors setting. ,
Required: False ,
}
string ,
masterLogErrors:
{
Description: Master log_errors setting. ,
Required: False ,
}
string ,
localLogErrorsMaxLength:
{
Description: Local log_errors_max_len setting. ,
Required: False ,
}
string ,
masterLogErrorsMaxLength:
{
Description: Master log_errors_max_len setting. ,
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 ,
}
,
}
WebApps_ListPremierAddOns (new)
Description :  Description for Gets the premier add-ons of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: PremierAddOn resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
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 ,
}
,
}
WebApps_GetPremierAddOn (new)
Description :  Description for Gets a named add-on of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
premierAddOnName:
{
Description: Add-on name. ,
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: PremierAddOn resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
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 ,
}
,
}
WebApps_AddPremierAddOn (new)
Description :  Description for Updates a named add-on of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
premierAddOnName:
{
Description: Add-on name. ,
Required: True ,
}
string ,
premierAddOn:
{
Description: A JSON representation of the edited premier add-on. ,
Required: True ,
}
{
properties:
{
Description: PremierAddOn resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
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: PremierAddOn resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
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 ,
}
,
}
WebApps_DeletePremierAddOn (new)
Description :  Description for Delete a premier add-on from an app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
premierAddOnName:
{
Description: Add-on name. ,
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 ,
}
,
}
WebApps_UpdatePremierAddOn (new)
Description :  Description for Updates a named add-on of an app.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
premierAddOnName:
{
Description: Add-on name. ,
Required: True ,
}
string ,
premierAddOn:
{
Description: A JSON representation of the edited premier add-on. ,
Required: True ,
}
{
properties:
{
Description: PremierAddOnPatchResource resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
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: PremierAddOn resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
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 ,
}
,
}
WebApps_GetPrivateAccess (new)
Description :  Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
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: PrivateAccess resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: Whether private access is enabled or not. ,
Required: False ,
}
boolean ,
virtualNetworks:
{
Description: The Virtual Networks (and subnets) allowed to access the site privately. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Virtual Network. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the Virtual Network. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceId:
{
Description: The ARM uri of the Virtual Network ,
Required: False ,
}
string ,
subnets:
{
Description: A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. ,
Required: False ,
}
[
{
name:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the subnet. ,
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 ,
}
,
}
WebApps_PutPrivateAccessVnet (new)
Description :  Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
access:
{
Description: The information for the private access ,
Required: True ,
}
{
properties:
{
Description: PrivateAccess resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: Whether private access is enabled or not. ,
Required: False ,
}
boolean ,
virtualNetworks:
{
Description: The Virtual Networks (and subnets) allowed to access the site privately. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Virtual Network. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the Virtual Network. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceId:
{
Description: The ARM uri of the Virtual Network ,
Required: False ,
}
string ,
subnets:
{
Description: A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. ,
Required: False ,
}
[
{
name:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}
,
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: PrivateAccess resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: Whether private access is enabled or not. ,
Required: False ,
}
boolean ,
virtualNetworks:
{
Description: The Virtual Networks (and subnets) allowed to access the site privately. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Virtual Network. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the Virtual Network. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceId:
{
Description: The ARM uri of the Virtual Network ,
Required: False ,
}
string ,
subnets:
{
Description: A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. ,
Required: False ,
}
[
{
name:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the subnet. ,
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 ,
}
,
}
WebApps_GetPrivateEndpointConnectionList (new)
Description :  Description for Gets the list of private endpoint connections associated with a site
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
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 ,
}
,
}
WebApps_GetPrivateEndpointConnection (new)
Description :  Description for Gets a private endpoint connection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
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 ,
}
,
}
WebApps_ApproveOrRejectPrivateEndpointConnection (new)
Description :  Description for Approves or rejects a private endpoint connection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
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 ,
}
,
}
WebApps_DeletePrivateEndpointConnection (new)
Description :  Description for Deletes a private endpoint connection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
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 ,
}
,
}
WebApps_GetPrivateLinkResources (new)
Description :  Description for Gets the private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateLinkResources
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
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 ,
}
,
}
WebApps_ListProcesses (new)
Description :  Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
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: ProcessInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: ARM Identifier for deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
deployment_name:
{
Description: Deployment name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
minidump:
{
Description: Minidump URI. ,
Required: False ,
}
string ,
is_profile_running:
{
Description: Is profile running? ,
Required: False ,
}
boolean ,
is_iis_profile_running:
{
Description: Is the IIS Profile running? ,
Required: False ,
}
boolean ,
iis_profile_timeout_in_seconds:
{
Description: IIS Profile timeout (seconds). ,
Format: double ,
Required: False ,
}
number ,
parent:
{
Description: Parent process. ,
Required: False ,
}
string ,
children:
{
Description: Child process list. ,
Required: False ,
}
[
string ,
]
,
threads:
{
Description: Thread list. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
open_file_handles:
{
Description: List of open files. ,
Required: False ,
}
[
string ,
]
,
modules:
{
Description: List of modules. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
file_name:
{
Description: File name of this process. ,
Required: False ,
}
string ,
command_line:
{
Description: Command line. ,
Required: False ,
}
string ,
user_name:
{
Description: User name. ,
Required: False ,
}
string ,
handle_count:
{
Description: Handle count. ,
Format: int32 ,
Required: False ,
}
integer ,
module_count:
{
Description: Module count. ,
Format: int32 ,
Required: False ,
}
integer ,
thread_count:
{
Description: Thread count. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_cpu_time:
{
Description: Total CPU time. ,
Required: False ,
}
string ,
user_cpu_time:
{
Description: User CPU time. ,
Required: False ,
}
string ,
privileged_cpu_time:
{
Description: Privileged CPU time. ,
Required: False ,
}
string ,
working_set:
{
Description: Working set. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_working_set:
{
Description: Peak working set. ,
Format: int64 ,
Required: False ,
}
integer ,
private_memory:
{
Description: Private memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
virtual_memory:
{
Description: Virtual memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_virtual_memory:
{
Description: Peak virtual memory usage. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_system_memory:
{
Description: Paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
non_paged_system_memory:
{
Description: Non-paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_memory:
{
Description: Paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_paged_memory:
{
Description: Peak paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
time_stamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
environment_variables:
{
Description: List of environment variables. ,
Required: False ,
}
object ,
is_scm_site:
{
Description: Is this the SCM site? ,
Required: False ,
}
boolean ,
is_webjob:
{
Description: Is this a Web Job? ,
Required: False ,
}
boolean ,
description:
{
Description: Description of process. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetProcess (new)
Description :  Description for Get process information by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
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: ProcessInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: ARM Identifier for deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
deployment_name:
{
Description: Deployment name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
minidump:
{
Description: Minidump URI. ,
Required: False ,
}
string ,
is_profile_running:
{
Description: Is profile running? ,
Required: False ,
}
boolean ,
is_iis_profile_running:
{
Description: Is the IIS Profile running? ,
Required: False ,
}
boolean ,
iis_profile_timeout_in_seconds:
{
Description: IIS Profile timeout (seconds). ,
Format: double ,
Required: False ,
}
number ,
parent:
{
Description: Parent process. ,
Required: False ,
}
string ,
children:
{
Description: Child process list. ,
Required: False ,
}
[
string ,
]
,
threads:
{
Description: Thread list. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
open_file_handles:
{
Description: List of open files. ,
Required: False ,
}
[
string ,
]
,
modules:
{
Description: List of modules. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
file_name:
{
Description: File name of this process. ,
Required: False ,
}
string ,
command_line:
{
Description: Command line. ,
Required: False ,
}
string ,
user_name:
{
Description: User name. ,
Required: False ,
}
string ,
handle_count:
{
Description: Handle count. ,
Format: int32 ,
Required: False ,
}
integer ,
module_count:
{
Description: Module count. ,
Format: int32 ,
Required: False ,
}
integer ,
thread_count:
{
Description: Thread count. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_cpu_time:
{
Description: Total CPU time. ,
Required: False ,
}
string ,
user_cpu_time:
{
Description: User CPU time. ,
Required: False ,
}
string ,
privileged_cpu_time:
{
Description: Privileged CPU time. ,
Required: False ,
}
string ,
working_set:
{
Description: Working set. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_working_set:
{
Description: Peak working set. ,
Format: int64 ,
Required: False ,
}
integer ,
private_memory:
{
Description: Private memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
virtual_memory:
{
Description: Virtual memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_virtual_memory:
{
Description: Peak virtual memory usage. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_system_memory:
{
Description: Paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
non_paged_system_memory:
{
Description: Non-paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_memory:
{
Description: Paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_paged_memory:
{
Description: Peak paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
time_stamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
environment_variables:
{
Description: List of environment variables. ,
Required: False ,
}
object ,
is_scm_site:
{
Description: Is this the SCM site? ,
Required: False ,
}
boolean ,
is_webjob:
{
Description: Is this a Web Job? ,
Required: False ,
}
boolean ,
description:
{
Description: Description of process. ,
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 ,
}
,
}
WebApps_DeleteProcess (new)
Description :  Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_GetProcessDump (new)
Description :  Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
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: file ,
}

⚐ 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 ,
}
,
}
WebApps_ListProcessModules (new)
Description :  Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
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: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetProcessModule (new)
Description :  Description for Get process information by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
baseAddress:
{
Description: Module base address. ,
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: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
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 ,
}
,
}
WebApps_ListProcessThreads (new)
Description :  Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
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: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_ListPublicCertificates (new)
Description :  Description for Get public certificates for an app or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: PublicCertificate resource specific properties ,
Required: False ,
}
{
blob:
{
Description: Public Certificate byte array ,
Format: byte ,
Required: False ,
}
string ,
publicCertificateLocation:
{
Description: Public Certificate Location ,
Enum:
{
CurrentUserMy: No description available. ,
LocalMachineMy: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: Certificate Thumbprint ,
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 ,
}
,
}
WebApps_GetPublicCertificate (new)
Description :  Description for Get the named public certificate for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
publicCertificateName:
{
Description: Public certificate name. ,
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: PublicCertificate resource specific properties ,
Required: False ,
}
{
blob:
{
Description: Public Certificate byte array ,
Format: byte ,
Required: False ,
}
string ,
publicCertificateLocation:
{
Description: Public Certificate Location ,
Enum:
{
CurrentUserMy: No description available. ,
LocalMachineMy: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: Certificate Thumbprint ,
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 ,
}
,
}
WebApps_CreateOrUpdatePublicCertificate (new)
Description :  Description for Creates a hostname binding for an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
publicCertificateName:
{
Description: Public certificate name. ,
Required: True ,
}
string ,
publicCertificate:
{
Description: Public certificate details. This is the JSON representation of a PublicCertificate object. ,
Required: True ,
}
{
properties:
{
Description: PublicCertificate resource specific properties ,
Required: False ,
}
{
blob:
{
Description: Public Certificate byte array ,
Format: byte ,
Required: False ,
}
string ,
publicCertificateLocation:
{
Description: Public Certificate Location ,
Enum:
{
CurrentUserMy: No description available. ,
LocalMachineMy: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: Certificate Thumbprint ,
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: PublicCertificate resource specific properties ,
Required: False ,
}
{
blob:
{
Description: Public Certificate byte array ,
Format: byte ,
Required: False ,
}
string ,
publicCertificateLocation:
{
Description: Public Certificate Location ,
Enum:
{
CurrentUserMy: No description available. ,
LocalMachineMy: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: Certificate Thumbprint ,
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 ,
}
,
}
WebApps_DeletePublicCertificate (new)
Description :  Description for Deletes a hostname binding for an app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
publicCertificateName:
{
Description: Public certificate name. ,
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 ,
}
,
}
WebApps_ListPublishingProfileXmlWithSecrets (new)
Description :  Description for Gets the publishing profile for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
publishingProfileOptions:
{
Description: Specifies publishingProfileOptions for publishing profile. For example, use {"format": "FileZilla3"} to get a FileZilla publishing profile. ,
Required: True ,
}
{
format:
{
Description: Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp ,
Enum:
{
FileZilla3: No description available. ,
WebDeploy: No description available. ,
Ftp: No description available. ,
}
,
Required: False ,
}
enum ,
includeDisasterRecoveryEndpoints:
{
Description: Include the DisasterRecover endpoint if true ,
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)

{
$schema: file ,
}

⚐ 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 ,
}
,
}
WebApps_ResetProductionSlotConfig (new)
Description :  Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 ,
}
,
}
WebApps_Restart (new)
Description :  Description for Restarts an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
softRestart:
{
Description: Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app. ,
Required: False ,
}
boolean ,
synchronous:
{
Description: Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous). ,
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)

{}

⚐ 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 ,
}
,
}
WebApps_RestoreFromBackupBlob (new)
Description :  Description for Restores an app from a backup blob in Azure Storage.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request . ,
Required: True ,
}
{
properties:
{
Description: RestoreRequest resource specific properties ,
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup. ,
Required: False ,
}
string ,
overwrite:
{
Description: true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. ,
Required: True ,
}
boolean ,
siteName:
{
Description: Name of an app. ,
Required: False ,
}
string ,
databases:
{
Description: Collection of databases which should be restored. This list has to match the list of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
ignoreConflictingHostNames:
{
Description: Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
ignoreDatabases:
{
Description: Ignore the databases and only restore the site content ,
Required: False ,
}
boolean ,
appServicePlan:
{
Description: Specify app service plan that will own restored site. ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
Snapshot: No description available. ,
CloudFS: No description available. ,
}
,
Required: False ,
}
enum ,
adjustConnectionStrings:
{
Description: true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false. ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring an app to an App Service Environment). ,
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 (202)

{}

⚐ 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 ,
}
,
}
WebApps_RestoreFromDeletedApp (new)
Description :  Description for Restores a deleted web app to this web app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
restoreRequest:
{
Description: Deleted web app restore information. ,
Required: True ,
}
{
properties:
{
Description: DeletedAppRestoreRequest resource specific properties ,
Required: False ,
}
{
deletedSiteId:
{
Description: ARM resource ID of the deleted app. Example: /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId} ,
Required: False ,
}
string ,
recoverConfiguration:
{
Description: If true, deleted site configuration, in addition to content, will be restored. ,
Required: False ,
}
boolean ,
snapshotTime:
{
Description: Point in time to restore the deleted app from, formatted as a DateTime string. If unspecified, default value is the time that the app was deleted. ,
Required: False ,
}
string ,
useDRSecondary:
{
Description: If true, the snapshot is retrieved from DRSecondary endpoint. ,
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 (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 ,
}
,
}
WebApps_RestoreSnapshot (new)
Description :  Description for Restores a web app from a snapshot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
restoreRequest:
{
Description: Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. ,
Required: True ,
}
{
properties:
{
Description: SnapshotRestoreRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app restore should be done, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoverySource:
{
Description: Optional. Specifies the web app that snapshot contents will be retrieved from. If empty, the targeted web app will be used as the source. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the source app. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the restore operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
useDRSecondary:
{
Description: If true, the snapshot is retrieved from DRSecondary endpoint. ,
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 (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 ,
}
,
}
WebApps_ListSiteContainers (new)
Description :  Lists all the site containers of a site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: SiteContainer resource specific properties ,
Required: False ,
}
{
image:
{
Description: Image Name ,
Required: True ,
}
string ,
targetPort:
{
Description: Target Port ,
Required: False ,
}
string ,
isMain:
{
Description: true if the container is the main site container; false otherwise. ,
Required: True ,
}
boolean ,
startUpCommand:
{
Description: StartUp Command ,
Required: False ,
}
string ,
authType:
{
Description: Auth Type ,
Enum:
{
Anonymous: No description available. ,
UserCredentials: No description available. ,
SystemIdentity: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userName:
{
Description: User Name ,
Required: False ,
}
string ,
passwordSecret:
{
Description: Password Secret ,
Required: False ,
}
string ,
userManagedIdentityClientId:
{
Description: UserManagedIdentity ClientId ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last Modified Time ,
Format: date-time ,
Required: False ,
}
string ,
volumeMounts:
{
Description: List of volume mounts ,
Required: False ,
}
[
{
volumeSubPath:
{
Description: Sub path in the volume where volume is mounted from. ,
Required: True ,
}
string ,
containerMountPath:
{
Description: Target path on the container where volume is mounted on ,
Required: True ,
}
string ,
data:
{
Description: Config Data to be mounted on the volume ,
Required: False ,
}
string ,
readOnly:
{
Description: Boolean to specify if the mount is read only on the container ,
Required: False ,
}
boolean ,
}
,
]
,
inheritAppSettingsAndConnectionStrings:
{
Description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise. ,
Required: False ,
}
boolean ,
environmentVariables:
{
Description: List of environment variables ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name ,
Required: True ,
}
string ,
value:
{
Description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. ,
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 ,
}
,
}
WebApps_GetSiteContainer (new)
Description :  Gets a site container of a site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
containerName:
{
Description: Site Container Name ,
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: SiteContainer resource specific properties ,
Required: False ,
}
{
image:
{
Description: Image Name ,
Required: True ,
}
string ,
targetPort:
{
Description: Target Port ,
Required: False ,
}
string ,
isMain:
{
Description: true if the container is the main site container; false otherwise. ,
Required: True ,
}
boolean ,
startUpCommand:
{
Description: StartUp Command ,
Required: False ,
}
string ,
authType:
{
Description: Auth Type ,
Enum:
{
Anonymous: No description available. ,
UserCredentials: No description available. ,
SystemIdentity: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userName:
{
Description: User Name ,
Required: False ,
}
string ,
passwordSecret:
{
Description: Password Secret ,
Required: False ,
}
string ,
userManagedIdentityClientId:
{
Description: UserManagedIdentity ClientId ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last Modified Time ,
Format: date-time ,
Required: False ,
}
string ,
volumeMounts:
{
Description: List of volume mounts ,
Required: False ,
}
[
{
volumeSubPath:
{
Description: Sub path in the volume where volume is mounted from. ,
Required: True ,
}
string ,
containerMountPath:
{
Description: Target path on the container where volume is mounted on ,
Required: True ,
}
string ,
data:
{
Description: Config Data to be mounted on the volume ,
Required: False ,
}
string ,
readOnly:
{
Description: Boolean to specify if the mount is read only on the container ,
Required: False ,
}
boolean ,
}
,
]
,
inheritAppSettingsAndConnectionStrings:
{
Description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise. ,
Required: False ,
}
boolean ,
environmentVariables:
{
Description: List of environment variables ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name ,
Required: True ,
}
string ,
value:
{
Description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. ,
Required: True ,
}
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 ,
}
,
}
WebApps_CreateOrUpdateSiteContainer (new)
Description :  Creates or Updates a site container for a site, or a deployment slot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
containerName:
{
Description: Site Container Name ,
Required: True ,
}
string ,
request:
{
Description: Container Entity ,
Required: True ,
}
{
properties:
{
Description: SiteContainer resource specific properties ,
Required: False ,
}
{
image:
{
Description: Image Name ,
Required: True ,
}
string ,
targetPort:
{
Description: Target Port ,
Required: False ,
}
string ,
isMain:
{
Description: true if the container is the main site container; false otherwise. ,
Required: True ,
}
boolean ,
startUpCommand:
{
Description: StartUp Command ,
Required: False ,
}
string ,
authType:
{
Description: Auth Type ,
Enum:
{
Anonymous: No description available. ,
UserCredentials: No description available. ,
SystemIdentity: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userName:
{
Description: User Name ,
Required: False ,
}
string ,
passwordSecret:
{
Description: Password Secret ,
Required: False ,
}
string ,
userManagedIdentityClientId:
{
Description: UserManagedIdentity ClientId ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last Modified Time ,
Format: date-time ,
Required: False ,
}
string ,
volumeMounts:
{
Description: List of volume mounts ,
Required: False ,
}
[
{
volumeSubPath:
{
Description: Sub path in the volume where volume is mounted from. ,
Required: True ,
}
string ,
containerMountPath:
{
Description: Target path on the container where volume is mounted on ,
Required: True ,
}
string ,
data:
{
Description: Config Data to be mounted on the volume ,
Required: False ,
}
string ,
readOnly:
{
Description: Boolean to specify if the mount is read only on the container ,
Required: False ,
}
boolean ,
}
,
]
,
inheritAppSettingsAndConnectionStrings:
{
Description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise. ,
Required: False ,
}
boolean ,
environmentVariables:
{
Description: List of environment variables ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name ,
Required: True ,
}
string ,
value:
{
Description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. ,
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 (201)

{
properties:
{
Description: SiteContainer resource specific properties ,
Required: False ,
}
{
image:
{
Description: Image Name ,
Required: True ,
}
string ,
targetPort:
{
Description: Target Port ,
Required: False ,
}
string ,
isMain:
{
Description: true if the container is the main site container; false otherwise. ,
Required: True ,
}
boolean ,
startUpCommand:
{
Description: StartUp Command ,
Required: False ,
}
string ,
authType:
{
Description: Auth Type ,
Enum:
{
Anonymous: No description available. ,
UserCredentials: No description available. ,
SystemIdentity: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userName:
{
Description: User Name ,
Required: False ,
}
string ,
passwordSecret:
{
Description: Password Secret ,
Required: False ,
}
string ,
userManagedIdentityClientId:
{
Description: UserManagedIdentity ClientId ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last Modified Time ,
Format: date-time ,
Required: False ,
}
string ,
volumeMounts:
{
Description: List of volume mounts ,
Required: False ,
}
[
{
volumeSubPath:
{
Description: Sub path in the volume where volume is mounted from. ,
Required: True ,
}
string ,
containerMountPath:
{
Description: Target path on the container where volume is mounted on ,
Required: True ,
}
string ,
data:
{
Description: Config Data to be mounted on the volume ,
Required: False ,
}
string ,
readOnly:
{
Description: Boolean to specify if the mount is read only on the container ,
Required: False ,
}
boolean ,
}
,
]
,
inheritAppSettingsAndConnectionStrings:
{
Description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise. ,
Required: False ,
}
boolean ,
environmentVariables:
{
Description: List of environment variables ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name ,
Required: True ,
}
string ,
value:
{
Description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SiteContainer resource specific properties ,
Required: False ,
}
{
image:
{
Description: Image Name ,
Required: True ,
}
string ,
targetPort:
{
Description: Target Port ,
Required: False ,
}
string ,
isMain:
{
Description: true if the container is the main site container; false otherwise. ,
Required: True ,
}
boolean ,
startUpCommand:
{
Description: StartUp Command ,
Required: False ,
}
string ,
authType:
{
Description: Auth Type ,
Enum:
{
Anonymous: No description available. ,
UserCredentials: No description available. ,
SystemIdentity: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userName:
{
Description: User Name ,
Required: False ,
}
string ,
passwordSecret:
{
Description: Password Secret ,
Required: False ,
}
string ,
userManagedIdentityClientId:
{
Description: UserManagedIdentity ClientId ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last Modified Time ,
Format: date-time ,
Required: False ,
}
string ,
volumeMounts:
{
Description: List of volume mounts ,
Required: False ,
}
[
{
volumeSubPath:
{
Description: Sub path in the volume where volume is mounted from. ,
Required: True ,
}
string ,
containerMountPath:
{
Description: Target path on the container where volume is mounted on ,
Required: True ,
}
string ,
data:
{
Description: Config Data to be mounted on the volume ,
Required: False ,
}
string ,
readOnly:
{
Description: Boolean to specify if the mount is read only on the container ,
Required: False ,
}
boolean ,
}
,
]
,
inheritAppSettingsAndConnectionStrings:
{
Description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise. ,
Required: False ,
}
boolean ,
environmentVariables:
{
Description: List of environment variables ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name ,
Required: True ,
}
string ,
value:
{
Description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. ,
Required: True ,
}
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 ,
}
,
}
WebApps_DeleteSiteContainer (new)
Description :  Deletes a site container for a site, or a deployment slot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
containerName:
{
Description: Site Container Name ,
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 ,
}
,
}
WebApps_ListSiteExtensions (new)
Description :  Description for Get list of siteextensions for a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
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: SiteExtensionInfo resource specific properties ,
Required: False ,
}
{
extension_id:
{
Description: Site extension ID. ,
Required: False ,
}
string ,
title:
{
Required: False ,
}
string ,
extension_type:
{
Description: Site extension type. ,
Enum:
{
Gallery: No description available. ,
WebRoot: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description. ,
Required: False ,
}
string ,
version:
{
Description: Version information. ,
Required: False ,
}
string ,
extension_url:
{
Description: Extension URL. ,
Required: False ,
}
string ,
project_url:
{
Description: Project URL. ,
Required: False ,
}
string ,
icon_url:
{
Description: Icon URL. ,
Required: False ,
}
string ,
license_url:
{
Description: License URL. ,
Required: False ,
}
string ,
feed_url:
{
Description: Feed URL. ,
Required: False ,
}
string ,
authors:
{
Description: List of authors. ,
Required: False ,
}
[
string ,
]
,
installer_command_line_params:
{
Description: Installer command line parameters. ,
Required: False ,
}
string ,
published_date_time:
{
Description: Published timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
download_count:
{
Description: Count of downloads. ,
Format: int32 ,
Required: False ,
}
integer ,
local_is_latest_version:
{
Description: true if the local version is the latest version; false otherwise. ,
Required: False ,
}
boolean ,
local_path:
{
Description: Local path. ,
Required: False ,
}
string ,
installed_date_time:
{
Description: Installed timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Required: False ,
}
string ,
comment:
{
Description: Site Extension comment. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetSiteExtension (new)
Description :  Description for Get site extension information by its ID for a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
siteExtensionId:
{
Description: Site extension name. ,
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: SiteExtensionInfo resource specific properties ,
Required: False ,
}
{
extension_id:
{
Description: Site extension ID. ,
Required: False ,
}
string ,
title:
{
Required: False ,
}
string ,
extension_type:
{
Description: Site extension type. ,
Enum:
{
Gallery: No description available. ,
WebRoot: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description. ,
Required: False ,
}
string ,
version:
{
Description: Version information. ,
Required: False ,
}
string ,
extension_url:
{
Description: Extension URL. ,
Required: False ,
}
string ,
project_url:
{
Description: Project URL. ,
Required: False ,
}
string ,
icon_url:
{
Description: Icon URL. ,
Required: False ,
}
string ,
license_url:
{
Description: License URL. ,
Required: False ,
}
string ,
feed_url:
{
Description: Feed URL. ,
Required: False ,
}
string ,
authors:
{
Description: List of authors. ,
Required: False ,
}
[
string ,
]
,
installer_command_line_params:
{
Description: Installer command line parameters. ,
Required: False ,
}
string ,
published_date_time:
{
Description: Published timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
download_count:
{
Description: Count of downloads. ,
Format: int32 ,
Required: False ,
}
integer ,
local_is_latest_version:
{
Description: true if the local version is the latest version; false otherwise. ,
Required: False ,
}
boolean ,
local_path:
{
Description: Local path. ,
Required: False ,
}
string ,
installed_date_time:
{
Description: Installed timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Required: False ,
}
string ,
comment:
{
Description: Site Extension comment. ,
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 ,
}
,
}
WebApps_InstallSiteExtension (new)
Description :  Description for Install site extension on a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
siteExtensionId:
{
Description: Site extension name. ,
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 (201)

{
properties:
{
Description: SiteExtensionInfo resource specific properties ,
Required: False ,
}
{
extension_id:
{
Description: Site extension ID. ,
Required: False ,
}
string ,
title:
{
Required: False ,
}
string ,
extension_type:
{
Description: Site extension type. ,
Enum:
{
Gallery: No description available. ,
WebRoot: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description. ,
Required: False ,
}
string ,
version:
{
Description: Version information. ,
Required: False ,
}
string ,
extension_url:
{
Description: Extension URL. ,
Required: False ,
}
string ,
project_url:
{
Description: Project URL. ,
Required: False ,
}
string ,
icon_url:
{
Description: Icon URL. ,
Required: False ,
}
string ,
license_url:
{
Description: License URL. ,
Required: False ,
}
string ,
feed_url:
{
Description: Feed URL. ,
Required: False ,
}
string ,
authors:
{
Description: List of authors. ,
Required: False ,
}
[
string ,
]
,
installer_command_line_params:
{
Description: Installer command line parameters. ,
Required: False ,
}
string ,
published_date_time:
{
Description: Published timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
download_count:
{
Description: Count of downloads. ,
Format: int32 ,
Required: False ,
}
integer ,
local_is_latest_version:
{
Description: true if the local version is the latest version; false otherwise. ,
Required: False ,
}
boolean ,
local_path:
{
Description: Local path. ,
Required: False ,
}
string ,
installed_date_time:
{
Description: Installed timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Required: False ,
}
string ,
comment:
{
Description: Site Extension comment. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SiteExtensionInfo resource specific properties ,
Required: False ,
}
{
extension_id:
{
Description: Site extension ID. ,
Required: False ,
}
string ,
title:
{
Required: False ,
}
string ,
extension_type:
{
Description: Site extension type. ,
Enum:
{
Gallery: No description available. ,
WebRoot: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description. ,
Required: False ,
}
string ,
version:
{
Description: Version information. ,
Required: False ,
}
string ,
extension_url:
{
Description: Extension URL. ,
Required: False ,
}
string ,
project_url:
{
Description: Project URL. ,
Required: False ,
}
string ,
icon_url:
{
Description: Icon URL. ,
Required: False ,
}
string ,
license_url:
{
Description: License URL. ,
Required: False ,
}
string ,
feed_url:
{
Description: Feed URL. ,
Required: False ,
}
string ,
authors:
{
Description: List of authors. ,
Required: False ,
}
[
string ,
]
,
installer_command_line_params:
{
Description: Installer command line parameters. ,
Required: False ,
}
string ,
published_date_time:
{
Description: Published timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
download_count:
{
Description: Count of downloads. ,
Format: int32 ,
Required: False ,
}
integer ,
local_is_latest_version:
{
Description: true if the local version is the latest version; false otherwise. ,
Required: False ,
}
boolean ,
local_path:
{
Description: Local path. ,
Required: False ,
}
string ,
installed_date_time:
{
Description: Installed timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Required: False ,
}
string ,
comment:
{
Description: Site Extension comment. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{}

⚐ 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 ,
}
,
}
WebApps_DeleteSiteExtension (new)
Description :  Description for Remove a site extension from a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_ListSlots (new)
Description :  Description for Gets an app's deployment slots.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 (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 ,
}
,
}
WebApps_GetSlot (new)
Description :  Description for Gets the details of a web, mobile, or API app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. By default, this API returns the production slot. ,
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: 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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateSlot (new)
Description :  Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: A JSON representation of the app properties. See example. ,
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 ,
}
,
}
,
slot:
{
Description: Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot. ,
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: 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 ,
}
,
}

⚐ Response (202)

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

⚐ 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 ,
}
,
}
WebApps_DeleteSlot (new)
Description :  Description for Deletes a web, mobile, or API app, or one of the deployment slots.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app to delete. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot to delete. By default, the API deletes the production slot. ,
Required: True ,
}
string ,
deleteMetrics:
{
Description: If true, web app metrics are also deleted. ,
Required: False ,
}
boolean ,
deleteEmptyServerFarm:
{
Description: Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted. ,
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)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateSlot (new)
Description :  Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: A JSON representation of the app properties. See example. ,
Required: True ,
}
{
properties:
{
Description: SitePatchResource 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 ,
}
,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
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 ,
}
,
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 ,
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 ,
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 ,
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 ,
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 ,
}
,
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 ,
}
,
}
,
slot:
{
Description: Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot. ,
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: 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 ,
}
,
}

⚐ Response (202)

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

⚐ 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 ,
}
,
}
WebApps_AnalyzeCustomHostnameSlot (new)
Description :  Description for Analyze a custom hostname.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
hostName:
{
Description: Custom hostname. ,
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: CustomHostnameAnalysisResult resource specific properties ,
Required: False ,
}
{
isHostnameAlreadyVerified:
{
Description: true if hostname is already verified; otherwise, false. ,
Required: False ,
}
boolean ,
customDomainVerificationTest:
{
Description: DNS verification test result. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
customDomainVerificationFailureInfo:
{
Description: Raw failure information if DNS verification fails. ,
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 ,
}
,
hasConflictOnScaleUnit:
{
Description: true if there is a conflict on a scale unit; otherwise, false. ,
Required: False ,
}
boolean ,
hasConflictAcrossSubscription:
{
Description: true if there is a conflict across subscriptions; otherwise, false. ,
Required: False ,
}
boolean ,
conflictingAppResourceId:
{
Description: Name of the conflicting app on scale unit if it's within the same subscription. ,
Required: False ,
}
string ,
cNameRecords:
{
Description: CName records controller can see for this hostname. ,
Required: False ,
}
[
string ,
]
,
txtRecords:
{
Description: TXT records controller can see for this hostname. ,
Required: False ,
}
[
string ,
]
,
aRecords:
{
Description: A records controller can see for this hostname. ,
Required: False ,
}
[
string ,
]
,
alternateCNameRecords:
{
Description: Alternate CName records controller can see for this hostname. ,
Required: False ,
}
[
string ,
]
,
alternateTxtRecords:
{
Description: Alternate TXT records controller can see for this hostname. ,
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 ,
}
,
}
WebApps_ApplySlotConfigurationSlot (new)
Description :  Description for Applies the configuration settings from the target slot onto the current slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: JSON object that contains the target slot name. See example. ,
Required: True ,
}
{
targetSlot:
{
Description: Destination deployment slot during swap operation. ,
Required: True ,
}
string ,
preserveVnet:
{
Description: true to preserve Virtual Network to the slot during swap; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
slot:
{
Description: Name of the source slot. If a slot is not specified, the production slot is used as the source slot. ,
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 ,
}
,
}
WebApps_BackupSlot (new)
Description :  Description for Creates a backup of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
request:
{
Description: Backup configuration. You can use the JSON response from the POST action as input here. ,
Required: True ,
}
{
properties:
{
Description: BackupRequest resource specific properties ,
Required: False ,
}
{
backupName:
{
Description: Name of the backup. ,
Required: False ,
}
string ,
enabled:
{
Description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. ,
Required: False ,
}
boolean ,
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically. ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyUnit:
{
Description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) ,
Enum:
{
Day: No description available. ,
Hour: No description available. ,
}
,
Required: True ,
}
enum ,
keepAtLeastOneBackup:
{
Description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. ,
Required: True ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted. ,
Format: int32 ,
Required: True ,
}
integer ,
startTime:
{
Description: When the schedule should start working. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: Last time when this schedule was triggered. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot. ,
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: BackupItem resource specific properties ,
Required: False ,
}
{
id:
{
Description: Id of the backup. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: SAS URL for the storage account container which contains this backup. ,
Required: False ,
}
string ,
blobName:
{
Description: Name of the blob which contains data for this backup. ,
Required: False ,
}
string ,
name:
{
Description: Name of this backup. ,
Required: False ,
}
string ,
status:
{
Description: Backup status. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
Skipped: No description available. ,
PartiallySucceeded: No description available. ,
DeleteInProgress: No description available. ,
DeleteFailed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: Size of the backup in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: Timestamp of the backup creation. ,
Format: date-time ,
Required: False ,
}
string ,
log:
{
Description: Details regarding this backup. Might contain an error message. ,
Required: False ,
}
string ,
databases:
{
Description: List of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
scheduled:
{
Description: True if this backup has been created due to a schedule being triggered. ,
Required: False ,
}
boolean ,
lastRestoreTimeStamp:
{
Description: Timestamp of a last restore operation which used this backup. ,
Format: date-time ,
Required: False ,
}
string ,
finishedTimeStamp:
{
Description: Timestamp when this backup finished. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. ,
Required: False ,
}
string ,
websiteSizeInBytes:
{
Description: Size of the original web app which has been backed up. ,
Format: int64 ,
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 ,
}
,
}
WebApps_ListBackupsSlot (new)
Description :  Description for Gets existing backups of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot. ,
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: BackupItem resource specific properties ,
Required: False ,
}
{
id:
{
Description: Id of the backup. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: SAS URL for the storage account container which contains this backup. ,
Required: False ,
}
string ,
blobName:
{
Description: Name of the blob which contains data for this backup. ,
Required: False ,
}
string ,
name:
{
Description: Name of this backup. ,
Required: False ,
}
string ,
status:
{
Description: Backup status. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
Skipped: No description available. ,
PartiallySucceeded: No description available. ,
DeleteInProgress: No description available. ,
DeleteFailed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: Size of the backup in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: Timestamp of the backup creation. ,
Format: date-time ,
Required: False ,
}
string ,
log:
{
Description: Details regarding this backup. Might contain an error message. ,
Required: False ,
}
string ,
databases:
{
Description: List of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
scheduled:
{
Description: True if this backup has been created due to a schedule being triggered. ,
Required: False ,
}
boolean ,
lastRestoreTimeStamp:
{
Description: Timestamp of a last restore operation which used this backup. ,
Format: date-time ,
Required: False ,
}
string ,
finishedTimeStamp:
{
Description: Timestamp when this backup finished. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. ,
Required: False ,
}
string ,
websiteSizeInBytes:
{
Description: Size of the original web app which has been backed up. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_GetBackupStatusSlot (new)
Description :  Description for Gets a backup of an app by its ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
backupId:
{
Description: ID of the backup. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot. ,
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: BackupItem resource specific properties ,
Required: False ,
}
{
id:
{
Description: Id of the backup. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: SAS URL for the storage account container which contains this backup. ,
Required: False ,
}
string ,
blobName:
{
Description: Name of the blob which contains data for this backup. ,
Required: False ,
}
string ,
name:
{
Description: Name of this backup. ,
Required: False ,
}
string ,
status:
{
Description: Backup status. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
Skipped: No description available. ,
PartiallySucceeded: No description available. ,
DeleteInProgress: No description available. ,
DeleteFailed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: Size of the backup in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: Timestamp of the backup creation. ,
Format: date-time ,
Required: False ,
}
string ,
log:
{
Description: Details regarding this backup. Might contain an error message. ,
Required: False ,
}
string ,
databases:
{
Description: List of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
scheduled:
{
Description: True if this backup has been created due to a schedule being triggered. ,
Required: False ,
}
boolean ,
lastRestoreTimeStamp:
{
Description: Timestamp of a last restore operation which used this backup. ,
Format: date-time ,
Required: False ,
}
string ,
finishedTimeStamp:
{
Description: Timestamp when this backup finished. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. ,
Required: False ,
}
string ,
websiteSizeInBytes:
{
Description: Size of the original web app which has been backed up. ,
Format: int64 ,
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 ,
}
,
}
WebApps_DeleteBackupSlot (new)
Description :  Description for Deletes a backup of an app by its ID.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
backupId:
{
Description: ID of the backup. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_ListBackupStatusSecretsSlot (new)
Description :  Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
backupId:
{
Description: ID of backup. ,
Required: True ,
}
string ,
request:
{
Description: Information on backup request. ,
Required: True ,
}
{
properties:
{
Description: BackupRequest resource specific properties ,
Required: False ,
}
{
backupName:
{
Description: Name of the backup. ,
Required: False ,
}
string ,
enabled:
{
Description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. ,
Required: False ,
}
boolean ,
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically. ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyUnit:
{
Description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) ,
Enum:
{
Day: No description available. ,
Hour: No description available. ,
}
,
Required: True ,
}
enum ,
keepAtLeastOneBackup:
{
Description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. ,
Required: True ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted. ,
Format: int32 ,
Required: True ,
}
integer ,
startTime:
{
Description: When the schedule should start working. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: Last time when this schedule was triggered. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: BackupItem resource specific properties ,
Required: False ,
}
{
id:
{
Description: Id of the backup. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: SAS URL for the storage account container which contains this backup. ,
Required: False ,
}
string ,
blobName:
{
Description: Name of the blob which contains data for this backup. ,
Required: False ,
}
string ,
name:
{
Description: Name of this backup. ,
Required: False ,
}
string ,
status:
{
Description: Backup status. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
Skipped: No description available. ,
PartiallySucceeded: No description available. ,
DeleteInProgress: No description available. ,
DeleteFailed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: Size of the backup in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: Timestamp of the backup creation. ,
Format: date-time ,
Required: False ,
}
string ,
log:
{
Description: Details regarding this backup. Might contain an error message. ,
Required: False ,
}
string ,
databases:
{
Description: List of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
scheduled:
{
Description: True if this backup has been created due to a schedule being triggered. ,
Required: False ,
}
boolean ,
lastRestoreTimeStamp:
{
Description: Timestamp of a last restore operation which used this backup. ,
Format: date-time ,
Required: False ,
}
string ,
finishedTimeStamp:
{
Description: Timestamp when this backup finished. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. ,
Required: False ,
}
string ,
websiteSizeInBytes:
{
Description: Size of the original web app which has been backed up. ,
Format: int64 ,
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 ,
}
,
}
WebApps_RestoreSlot (new)
Description :  Description for Restores a specific backup to another app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
backupId:
{
Description: ID of the backup. ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request . ,
Required: True ,
}
{
properties:
{
Description: RestoreRequest resource specific properties ,
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup. ,
Required: False ,
}
string ,
overwrite:
{
Description: true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. ,
Required: True ,
}
boolean ,
siteName:
{
Description: Name of an app. ,
Required: False ,
}
string ,
databases:
{
Description: Collection of databases which should be restored. This list has to match the list of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
ignoreConflictingHostNames:
{
Description: Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
ignoreDatabases:
{
Description: Ignore the databases and only restore the site content ,
Required: False ,
}
boolean ,
appServicePlan:
{
Description: Specify app service plan that will own restored site. ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
Snapshot: No description available. ,
CloudFS: No description available. ,
}
,
Required: False ,
}
enum ,
adjustConnectionStrings:
{
Description: true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false. ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring an app to an App Service Environment). ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot. ,
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 (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 ,
}
,
}
WebApps_ListBasicPublishingCredentialsPoliciesSlot (new)
Description :  Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
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: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
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 ,
}
,
}
WebApps_GetFtpAllowedSlot (new)
Description :  Description for Returns whether FTP is allowed on the site or not.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/ftp
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
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: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateFtpAllowedSlot (new)
Description :  Description for Updates whether FTP is allowed on the site or not.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/ftp
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
csmPublishingAccessPoliciesEntity:
{
Required: True ,
}
{
properties:
{
Description: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
}
,
slot:
{
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: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_GetScmAllowedSlot (new)
Description :  Description for Returns whether Scm basic auth is allowed on the site or not.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
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: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateScmAllowedSlot (new)
Description :  Description for Updates whether user publishing credentials are allowed on the site or not.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
csmPublishingAccessPoliciesEntity:
{
Required: True ,
}
{
properties:
{
Description: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
}
,
slot:
{
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: CsmPublishingCredentialsPoliciesEntity resource specific properties ,
Required: False ,
}
{
allow:
{
Description: true to allow access to a publishing method; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListConfigurationsSlot (new)
Description :  Description for List the configurations of an app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. ,
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 ,
}
{
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 ,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_UpdateApplicationSettingsSlot (new)
Description :  Description for Replaces the application settings of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
appSettings:
{
Description: Application settings of the app. ,
Required: True ,
}
{
properties:
{
Description: Settings. ,
Required: False ,
}
object ,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListApplicationSettingsSlot (new)
Description :  Description for Gets the application settings of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_UpdateAuthSettingsSlot (new)
Description :  Description for Updates the Authentication / Authorization settings associated with web app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
siteAuthSettings:
{
Description: Auth settings associated with web app. ,
Required: True ,
}
{
properties:
{
Description: SiteAuthSettings resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
Github: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
issuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
validateIssuer:
{
Description: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. ,
Required: False ,
}
boolean ,
allowedAudiences:
{
Description: Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClaimsAuthorization:
{
Description: Gets a JSON string containing the Azure AD Acl settings. ,
Required: False ,
}
string ,
googleClientId:
{
Description: The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecretSettingName:
{
Description: The app setting name that contains the client secret associated with the Google web application. ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecretSettingName:
{
Description: The app setting name that contains the app secret used for Facebook Login. ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
gitHubClientId:
{
Description: The Client Id of the GitHub app used for login. This setting is required for enabling Github login ,
Required: False ,
}
string ,
gitHubClientSecret:
{
Description: The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login. ,
Required: False ,
}
string ,
gitHubClientSecretSettingName:
{
Description: The app setting name that contains the client secret of the Github app used for GitHub Login. ,
Required: False ,
}
string ,
gitHubOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecretSettingName:
{
Description: The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
isAuthFromFile:
{
Description: "true" if the auth config settings should be read from a file, "false" otherwise ,
Required: False ,
}
string ,
authFilePath:
{
Description: The path of the config file containing auth settings. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
configVersion:
{
Description: The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization. ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: SiteAuthSettings resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
Github: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
issuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
validateIssuer:
{
Description: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. ,
Required: False ,
}
boolean ,
allowedAudiences:
{
Description: Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClaimsAuthorization:
{
Description: Gets a JSON string containing the Azure AD Acl settings. ,
Required: False ,
}
string ,
googleClientId:
{
Description: The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecretSettingName:
{
Description: The app setting name that contains the client secret associated with the Google web application. ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecretSettingName:
{
Description: The app setting name that contains the app secret used for Facebook Login. ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
gitHubClientId:
{
Description: The Client Id of the GitHub app used for login. This setting is required for enabling Github login ,
Required: False ,
}
string ,
gitHubClientSecret:
{
Description: The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login. ,
Required: False ,
}
string ,
gitHubClientSecretSettingName:
{
Description: The app setting name that contains the client secret of the Github app used for GitHub Login. ,
Required: False ,
}
string ,
gitHubOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecretSettingName:
{
Description: The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
isAuthFromFile:
{
Description: "true" if the auth config settings should be read from a file, "false" otherwise ,
Required: False ,
}
string ,
authFilePath:
{
Description: The path of the config file containing auth settings. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
configVersion:
{
Description: The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization. ,
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 ,
}
,
}
WebApps_GetAuthSettingsSlot (new)
Description :  Description for Gets the Authentication/Authorization settings of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot. ,
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: SiteAuthSettings resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
}
,
Required: False ,
}
enum ,
tokenStoreEnabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
defaultProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Enum:
{
AzureActiveDirectory: No description available. ,
Facebook: No description available. ,
Google: No description available. ,
MicrosoftAccount: No description available. ,
Twitter: No description available. ,
Github: No description available. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecret:
{
Description: The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
issuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
validateIssuer:
{
Description: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. ,
Required: False ,
}
boolean ,
allowedAudiences:
{
Description: Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
aadClaimsAuthorization:
{
Description: Gets a JSON string containing the Azure AD Acl settings. ,
Required: False ,
}
string ,
googleClientId:
{
Description: The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecret:
{
Description: The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
string ,
googleClientSecretSettingName:
{
Description: The app setting name that contains the client secret associated with the Google web application. ,
Required: False ,
}
string ,
googleOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ ,
Required: False ,
}
[
string ,
]
,
facebookAppId:
{
Description: The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecret:
{
Description: The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
string ,
facebookAppSecretSettingName:
{
Description: The app setting name that contains the app secret used for Facebook Login. ,
Required: False ,
}
string ,
facebookOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login ,
Required: False ,
}
[
string ,
]
,
gitHubClientId:
{
Description: The Client Id of the GitHub app used for login. This setting is required for enabling Github login ,
Required: False ,
}
string ,
gitHubClientSecret:
{
Description: The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login. ,
Required: False ,
}
string ,
gitHubClientSecretSettingName:
{
Description: The app setting name that contains the client secret of the Github app used for GitHub Login. ,
Required: False ,
}
string ,
gitHubOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional ,
Required: False ,
}
[
string ,
]
,
twitterConsumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecret:
{
Description: The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
twitterConsumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
microsoftAccountClientId:
{
Description: The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecret:
{
Description: The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm ,
Required: False ,
}
string ,
microsoftAccountClientSecretSettingName:
{
Description: The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. ,
Required: False ,
}
string ,
microsoftAccountOAuthScopes:
{
Description: The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx ,
Required: False ,
}
[
string ,
]
,
isAuthFromFile:
{
Description: "true" if the auth config settings should be read from a file, "false" otherwise ,
Required: False ,
}
string ,
authFilePath:
{
Description: The path of the config file containing auth settings. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
configVersion:
{
Description: The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization. ,
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 ,
}
,
}
WebApps_GetAuthSettingsV2WithoutSecretsSlot (new)
Description :  Gets site's Authentication / Authorization settings for apps via the V2 format
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot. ,
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: SiteAuthSettingsV2 resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of App Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
configFilePath:
{
Description: The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
requireAuthentication:
{
Description: true if the authentication flow is required any request is made; otherwise, false. ,
Required: False ,
}
boolean ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
Description: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
legacyMicrosoftAccount:
{
Description: The configuration settings of the legacy Microsoft Account provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the legacy Microsoft Account provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the legacy Microsoft Account provider token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
fileSystem:
{
Description: The configuration settings of the storage of the tokens if a file system is used. ,
Required: False ,
}
{
directory:
{
Description: The directory in which the tokens will be stored. ,
Required: False ,
}
string ,
}
,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app setting containing the SAS URL of the blob storage containing the tokens. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
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 ,
}
,
}
WebApps_UpdateAuthSettingsV2Slot (new)
Description :  Description for Updates site's Authentication / Authorization settings for apps via the V2 format
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
siteAuthSettingsV2:
{
Description: Auth settings associated with web app. ,
Required: True ,
}
{
properties:
{
Description: SiteAuthSettingsV2 resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of App Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
configFilePath:
{
Description: The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
requireAuthentication:
{
Description: true if the authentication flow is required any request is made; otherwise, false. ,
Required: False ,
}
boolean ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
Description: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
legacyMicrosoftAccount:
{
Description: The configuration settings of the legacy Microsoft Account provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the legacy Microsoft Account provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the legacy Microsoft Account provider token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
fileSystem:
{
Description: The configuration settings of the storage of the tokens if a file system is used. ,
Required: False ,
}
{
directory:
{
Description: The directory in which the tokens will be stored. ,
Required: False ,
}
string ,
}
,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app setting containing the SAS URL of the blob storage containing the tokens. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: SiteAuthSettingsV2 resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of App Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
configFilePath:
{
Description: The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
requireAuthentication:
{
Description: true if the authentication flow is required any request is made; otherwise, false. ,
Required: False ,
}
boolean ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
Description: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
legacyMicrosoftAccount:
{
Description: The configuration settings of the legacy Microsoft Account provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the legacy Microsoft Account provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the legacy Microsoft Account provider token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
fileSystem:
{
Description: The configuration settings of the storage of the tokens if a file system is used. ,
Required: False ,
}
{
directory:
{
Description: The directory in which the tokens will be stored. ,
Required: False ,
}
string ,
}
,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app setting containing the SAS URL of the blob storage containing the tokens. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
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 ,
}
,
}
WebApps_GetAuthSettingsV2Slot (new)
Description :  Description for Gets site's Authentication / Authorization settings for apps via the V2 format
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot. ,
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: SiteAuthSettingsV2 resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of App Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
configFilePath:
{
Description: The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
requireAuthentication:
{
Description: true if the authentication flow is required any request is made; otherwise, false. ,
Required: False ,
}
boolean ,
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
Description: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
legacyMicrosoftAccount:
{
Description: The configuration settings of the legacy Microsoft Account provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the legacy Microsoft Account provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the legacy Microsoft Account provider token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using App Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
fileSystem:
{
Description: The configuration settings of the storage of the tokens if a file system is used. ,
Required: False ,
}
{
directory:
{
Description: The directory in which the tokens will be stored. ,
Required: False ,
}
string ,
}
,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app setting containing the SAS URL of the blob storage containing the tokens. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
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 ,
}
,
}
WebApps_UpdateAzureStorageAccountsSlot (new)
Description :  Description for Updates the Azure storage account configurations of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
azureStorageAccounts:
{
Description: Azure storage accounts of the app. ,
Required: True ,
}
{
properties:
{
Description: Azure storage accounts. ,
Required: False ,
}
object ,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot. ,
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: Azure storage accounts. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListAzureStorageAccountsSlot (new)
Description :  Description for Gets the Azure storage account configurations of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot. ,
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: Azure storage accounts. ,
Required: False ,
}
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 ,
}
,
}
WebApps_UpdateBackupConfigurationSlot (new)
Description :  Description for Updates the backup configuration of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
request:
{
Description: Edited backup configuration. ,
Required: True ,
}
{
properties:
{
Description: BackupRequest resource specific properties ,
Required: False ,
}
{
backupName:
{
Description: Name of the backup. ,
Required: False ,
}
string ,
enabled:
{
Description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. ,
Required: False ,
}
boolean ,
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically. ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyUnit:
{
Description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) ,
Enum:
{
Day: No description available. ,
Hour: No description available. ,
}
,
Required: True ,
}
enum ,
keepAtLeastOneBackup:
{
Description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. ,
Required: True ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted. ,
Format: int32 ,
Required: True ,
}
integer ,
startTime:
{
Description: When the schedule should start working. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: Last time when this schedule was triggered. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot. ,
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: BackupRequest resource specific properties ,
Required: False ,
}
{
backupName:
{
Description: Name of the backup. ,
Required: False ,
}
string ,
enabled:
{
Description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. ,
Required: False ,
}
boolean ,
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically. ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyUnit:
{
Description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) ,
Enum:
{
Day: No description available. ,
Hour: No description available. ,
}
,
Required: True ,
}
enum ,
keepAtLeastOneBackup:
{
Description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. ,
Required: True ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted. ,
Format: int32 ,
Required: True ,
}
integer ,
startTime:
{
Description: When the schedule should start working. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: Last time when this schedule was triggered. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
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 ,
}
,
}
WebApps_DeleteBackupConfigurationSlot (new)
Description :  Description for Deletes the backup configuration of an app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the backup configuration for the production slot. ,
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 ,
}
,
}
WebApps_GetBackupConfigurationSlot (new)
Description :  Description for Gets the backup configuration of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot. ,
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: BackupRequest resource specific properties ,
Required: False ,
}
{
backupName:
{
Description: Name of the backup. ,
Required: False ,
}
string ,
enabled:
{
Description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. ,
Required: False ,
}
boolean ,
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically. ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyUnit:
{
Description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) ,
Enum:
{
Day: No description available. ,
Hour: No description available. ,
}
,
Required: True ,
}
enum ,
keepAtLeastOneBackup:
{
Description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. ,
Required: True ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted. ,
Format: int32 ,
Required: True ,
}
integer ,
startTime:
{
Description: When the schedule should start working. ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: Last time when this schedule was triggered. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
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 ,
}
,
}
WebApps_GetAppSettingsKeyVaultReferencesSlot (new)
Description :  Description for Gets the config reference app settings and status of an app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
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: ApiKVReference resource specific properties ,
Required: False ,
}
{
reference:
{
Required: False ,
}
string ,
status:
{
Enum:
{
Initialized: No description available. ,
Resolved: No description available. ,
InvalidSyntax: No description available. ,
MSINotEnabled: No description available. ,
VaultNotFound: No description available. ,
SecretNotFound: No description available. ,
SecretVersionNotFound: No description available. ,
AccessToKeyVaultDenied: No description available. ,
OtherReasons: No description available. ,
FetchTimedOut: No description available. ,
UnauthorizedClient: No description available. ,
}
,
Required: False ,
}
enum ,
vaultName:
{
Required: False ,
}
string ,
secretName:
{
Required: False ,
}
string ,
secretVersion:
{
Required: False ,
}
string ,
identityType:
{
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 ,
}
,
details:
{
Required: False ,
}
string ,
source:
{
Enum:
{
KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
activeVersion:
{
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 ,
}
,
}
WebApps_GetAppSettingKeyVaultReferenceSlot (new)
Description :  Description for Gets the config reference and status of an app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings/{appSettingKey}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
appSettingKey:
{
Description: App Setting key name. ,
Required: True ,
}
string ,
slot:
{
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: ApiKVReference resource specific properties ,
Required: False ,
}
{
reference:
{
Required: False ,
}
string ,
status:
{
Enum:
{
Initialized: No description available. ,
Resolved: No description available. ,
InvalidSyntax: No description available. ,
MSINotEnabled: No description available. ,
VaultNotFound: No description available. ,
SecretNotFound: No description available. ,
SecretVersionNotFound: No description available. ,
AccessToKeyVaultDenied: No description available. ,
OtherReasons: No description available. ,
FetchTimedOut: No description available. ,
UnauthorizedClient: No description available. ,
}
,
Required: False ,
}
enum ,
vaultName:
{
Required: False ,
}
string ,
secretName:
{
Required: False ,
}
string ,
secretVersion:
{
Required: False ,
}
string ,
identityType:
{
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 ,
}
,
details:
{
Required: False ,
}
string ,
source:
{
Enum:
{
KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
activeVersion:
{
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 ,
}
,
}
WebApps_GetSiteConnectionStringKeyVaultReferencesSlot (new)
Description :  Description for Gets the config reference app settings and status of an app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
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: ApiKVReference resource specific properties ,
Required: False ,
}
{
reference:
{
Required: False ,
}
string ,
status:
{
Enum:
{
Initialized: No description available. ,
Resolved: No description available. ,
InvalidSyntax: No description available. ,
MSINotEnabled: No description available. ,
VaultNotFound: No description available. ,
SecretNotFound: No description available. ,
SecretVersionNotFound: No description available. ,
AccessToKeyVaultDenied: No description available. ,
OtherReasons: No description available. ,
FetchTimedOut: No description available. ,
UnauthorizedClient: No description available. ,
}
,
Required: False ,
}
enum ,
vaultName:
{
Required: False ,
}
string ,
secretName:
{
Required: False ,
}
string ,
secretVersion:
{
Required: False ,
}
string ,
identityType:
{
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 ,
}
,
details:
{
Required: False ,
}
string ,
source:
{
Enum:
{
KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
activeVersion:
{
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 ,
}
,
}
WebApps_GetSiteConnectionStringKeyVaultReferenceSlot (new)
Description :  Description for Gets the config reference and status of an app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings/{connectionStringKey}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
connectionStringKey:
{
Required: True ,
}
string ,
slot:
{
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: ApiKVReference resource specific properties ,
Required: False ,
}
{
reference:
{
Required: False ,
}
string ,
status:
{
Enum:
{
Initialized: No description available. ,
Resolved: No description available. ,
InvalidSyntax: No description available. ,
MSINotEnabled: No description available. ,
VaultNotFound: No description available. ,
SecretNotFound: No description available. ,
SecretVersionNotFound: No description available. ,
AccessToKeyVaultDenied: No description available. ,
OtherReasons: No description available. ,
FetchTimedOut: No description available. ,
UnauthorizedClient: No description available. ,
}
,
Required: False ,
}
enum ,
vaultName:
{
Required: False ,
}
string ,
secretName:
{
Required: False ,
}
string ,
secretVersion:
{
Required: False ,
}
string ,
identityType:
{
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 ,
}
,
details:
{
Required: False ,
}
string ,
source:
{
Enum:
{
KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
activeVersion:
{
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 ,
}
,
}
WebApps_UpdateConnectionStringsSlot (new)
Description :  Description for Replaces the connection strings of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
connectionStrings:
{
Description: Connection strings of the app or deployment slot. See example. ,
Required: True ,
}
{
properties:
{
Description: Connection strings. ,
Required: False ,
}
object ,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot. ,
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: Connection strings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListConnectionStringsSlot (new)
Description :  Description for Gets the connection strings of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot. ,
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: Connection strings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_GetDiagnosticLogsConfigurationSlot (new)
Description :  Description for Gets the logging configuration of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot. ,
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: SiteLogsConfig resource specific properties ,
Required: False ,
}
{
applicationLogs:
{
Description: Application logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Application logs to file system configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureTableStorage:
{
Description: Application logs to azure table storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS URL to an Azure table with add/query/delete permissions. ,
Required: True ,
}
string ,
}
,
azureBlobStorage:
{
Description: Application logs to blob storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
httpLogs:
{
Description: HTTP logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Http logs to file system configuration. ,
Required: False ,
}
{
retentionInMb:
{
Description: Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
retentionInDays:
{
Description: Retention in days. Remove files older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
azureBlobStorage:
{
Description: Http logs to azure blob storage configuration. ,
Required: False ,
}
{
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateDiagnosticLogsConfigSlot (new)
Description :  Description for Updates the logging configuration of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
siteLogsConfig:
{
Description: A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties" property. ,
Required: True ,
}
{
properties:
{
Description: SiteLogsConfig resource specific properties ,
Required: False ,
}
{
applicationLogs:
{
Description: Application logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Application logs to file system configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureTableStorage:
{
Description: Application logs to azure table storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS URL to an Azure table with add/query/delete permissions. ,
Required: True ,
}
string ,
}
,
azureBlobStorage:
{
Description: Application logs to blob storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
httpLogs:
{
Description: HTTP logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Http logs to file system configuration. ,
Required: False ,
}
{
retentionInMb:
{
Description: Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
retentionInDays:
{
Description: Retention in days. Remove files older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
azureBlobStorage:
{
Description: Http logs to azure blob storage configuration. ,
Required: False ,
}
{
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot. ,
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: SiteLogsConfig resource specific properties ,
Required: False ,
}
{
applicationLogs:
{
Description: Application logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Application logs to file system configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureTableStorage:
{
Description: Application logs to azure table storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS URL to an Azure table with add/query/delete permissions. ,
Required: True ,
}
string ,
}
,
azureBlobStorage:
{
Description: Application logs to blob storage configuration. ,
Required: False ,
}
{
level:
{
Description: Log level. ,
Enum:
{
Off: No description available. ,
Verbose: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
httpLogs:
{
Description: HTTP logs configuration. ,
Required: False ,
}
{
fileSystem:
{
Description: Http logs to file system configuration. ,
Required: False ,
}
{
retentionInMb:
{
Description: Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
retentionInDays:
{
Description: Retention in days. Remove files older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
azureBlobStorage:
{
Description: Http logs to azure blob storage configuration. ,
Required: False ,
}
{
sasUrl:
{
Description: SAS url to a azure blob container with read/write/list/delete permissions. ,
Required: False ,
}
string ,
retentionInDays:
{
Description: Retention in days. Remove blobs older than X days. 0 or lower means no retention. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration. ,
Required: False ,
}
{
enabled:
{
Description: True if configuration is enabled, false if it is disabled and null if configuration is not set. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateMetadataSlot (new)
Description :  Description for Replaces the metadata of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
metadata:
{
Description: Edited metadata of the app or deployment slot. See example. ,
Required: True ,
}
{
properties:
{
Description: Settings. ,
Required: False ,
}
object ,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListMetadataSlot (new)
Description :  Description for Gets the metadata of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListPublishingCredentialsSlot (new)
Description :  Description for Gets the Git/FTP publishing credentials of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the publishing credentials for the production slot. ,
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: User resource specific properties ,
Required: False ,
}
{
publishingUserName:
{
Description: Username used for publishing. ,
Required: True ,
}
string ,
publishingPassword:
{
Description: Password used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHash:
{
Description: Password hash used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHashSalt:
{
Description: Password hash salt used for publishing. ,
Format: password ,
Required: False ,
}
string ,
scmUri:
{
Description: Url of SCM site. ,
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 ,
}
,
}
WebApps_UpdateSitePushSettingsSlot (new)
Description :  Description for Updates the Push settings associated with web app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
pushSettings:
{
Description: Push settings associated with web app. ,
Required: True ,
}
{
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 ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: 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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListSitePushSettingsSlot (new)
Description :  Description for Gets the Push settings associated with web app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: 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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_GetConfigurationSlot (new)
Description :  Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. ,
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 ,
}
{
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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateConfigurationSlot (new)
Description :  Description for Updates the configuration of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
siteConfig:
{
Description: JSON representation of a SiteConfig object. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
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 ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot. ,
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 ,
}
{
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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateConfigurationSlot (new)
Description :  Description for Updates the configuration of an app.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
siteConfig:
{
Description: JSON representation of a SiteConfig object. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
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 ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot. ,
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 ,
}
{
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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListConfigurationSnapshotInfoSlot (new)
Description :  Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. ,
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: SiteConfigurationSnapshotInfo resource specific properties ,
Required: False ,
}
{
time:
{
Description: The time the snapshot was taken. ,
Format: date-time ,
Required: False ,
}
string ,
snapshotId:
{
Description: The id of the snapshot ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_GetConfigurationSnapshotSlot (new)
Description :  Description for Gets a snapshot of the configuration of an app at a previous point in time.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
snapshotId:
{
Description: The ID of the snapshot to read. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. ,
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 ,
}
{
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 ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_RecoverSiteConfigurationSnapshotSlot (new)
Description :  Description for Reverts the configuration of an app to a previous snapshot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
snapshotId:
{
Description: The ID of the snapshot to read. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_GetWebSiteContainerLogsSlot (new)
Description :  Description for Gets the last lines of docker logs for the given site
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}

⚐ 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 ,
}
,
}
WebApps_GetContainerLogsZipSlot (new)
Description :  Description for Gets the ZIP archived docker log files for the given site
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}

⚐ 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 ,
}
,
}
WebApps_ListContinuousWebJobsSlot (new)
Description :  Description for List continuous web jobs for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ,
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: ContinuousWebJob resource specific properties ,
Required: False ,
}
{
status:
{
Description: Job status. ,
Enum:
{
Initializing: No description available. ,
Starting: No description available. ,
Running: No description available. ,
PendingRestart: No description available. ,
Stopped: No description available. ,
}
,
Required: False ,
}
enum ,
detailed_status:
{
Description: Detailed status. ,
Required: False ,
}
string ,
log_url:
{
Description: Log URL. ,
Required: False ,
}
string ,
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
settings:
{
Description: Job settings. ,
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 ,
}
,
}
WebApps_GetContinuousWebJobSlot (new)
Description :  Description for Gets a continuous web job by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ,
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: ContinuousWebJob resource specific properties ,
Required: False ,
}
{
status:
{
Description: Job status. ,
Enum:
{
Initializing: No description available. ,
Starting: No description available. ,
Running: No description available. ,
PendingRestart: No description available. ,
Stopped: No description available. ,
}
,
Required: False ,
}
enum ,
detailed_status:
{
Description: Detailed status. ,
Required: False ,
}
string ,
log_url:
{
Description: Log URL. ,
Required: False ,
}
string ,
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
settings:
{
Description: Job settings. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteContinuousWebJobSlot (new)
Description :  Description for Delete a continuous web job by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ,
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 ,
}
,
}
WebApps_StartContinuousWebJobSlot (new)
Description :  Description for Start a continuous web job for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_StopContinuousWebJobSlot (new)
Description :  Description for Stop a continuous web job for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_ListSlotSiteDeploymentStatusesSlot (new)
Description :  List deployment statuses for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot. ,
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: CsmDeploymentStatus resource specific properties ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment operation id. ,
Required: False ,
}
string ,
status:
{
Description: Deployment build status. ,
Enum:
{
TimedOut: No description available. ,
RuntimeFailed: No description available. ,
BuildAborted: No description available. ,
BuildFailed: No description available. ,
BuildRequestReceived: No description available. ,
BuildPending: No description available. ,
BuildInProgress: No description available. ,
BuildSuccessful: No description available. ,
PostBuildRestartRequired: No description available. ,
StartPolling: No description available. ,
StartPollingWithRestart: No description available. ,
RuntimeStarting: No description available. ,
RuntimeSuccessful: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfInstancesInProgress:
{
Description: Number of site instances currently being provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesSuccessful:
{
Description: Number of site instances provisioned successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesFailed:
{
Description: Number of site instances failed to provision. ,
Format: int32 ,
Required: False ,
}
integer ,
failedInstancesLogs:
{
Description: List of URLs pointing to logs for instances which failed to provision. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: List of errors. ,
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_GetSlotSiteDeploymentStatusSlot (new)
Description :  Gets the deployment status for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus/{deploymentStatusId}
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot. ,
Required: True ,
}
string ,
deploymentStatusId:
{
Description: GUID of the deployment operation. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: CsmDeploymentStatus resource specific properties ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment operation id. ,
Required: False ,
}
string ,
status:
{
Description: Deployment build status. ,
Enum:
{
TimedOut: No description available. ,
RuntimeFailed: No description available. ,
BuildAborted: No description available. ,
BuildFailed: No description available. ,
BuildRequestReceived: No description available. ,
BuildPending: No description available. ,
BuildInProgress: No description available. ,
BuildSuccessful: No description available. ,
PostBuildRestartRequired: No description available. ,
StartPolling: No description available. ,
StartPollingWithRestart: No description available. ,
RuntimeStarting: No description available. ,
RuntimeSuccessful: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfInstancesInProgress:
{
Description: Number of site instances currently being provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesSuccessful:
{
Description: Number of site instances provisioned successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesFailed:
{
Description: Number of site instances failed to provision. ,
Format: int32 ,
Required: False ,
}
integer ,
failedInstancesLogs:
{
Description: List of URLs pointing to logs for instances which failed to provision. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: List of errors. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: CsmDeploymentStatus resource specific properties ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment operation id. ,
Required: False ,
}
string ,
status:
{
Description: Deployment build status. ,
Enum:
{
TimedOut: No description available. ,
RuntimeFailed: No description available. ,
BuildAborted: No description available. ,
BuildFailed: No description available. ,
BuildRequestReceived: No description available. ,
BuildPending: No description available. ,
BuildInProgress: No description available. ,
BuildSuccessful: No description available. ,
PostBuildRestartRequired: No description available. ,
StartPolling: No description available. ,
StartPollingWithRestart: No description available. ,
RuntimeStarting: No description available. ,
RuntimeSuccessful: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfInstancesInProgress:
{
Description: Number of site instances currently being provisioned. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesSuccessful:
{
Description: Number of site instances provisioned successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfInstancesFailed:
{
Description: Number of site instances failed to provision. ,
Format: int32 ,
Required: False ,
}
integer ,
failedInstancesLogs:
{
Description: List of URLs pointing to logs for instances which failed to provision. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: List of errors. ,
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListDeploymentsSlot (new)
Description :  Description for List deployments for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
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: Deployment resource specific properties ,
Required: False ,
}
{
status:
{
Description: Deployment status. ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Details about deployment status. ,
Required: False ,
}
string ,
author:
{
Description: Who authored the deployment. ,
Required: False ,
}
string ,
deployer:
{
Description: Who performed the deployment. ,
Required: False ,
}
string ,
author_email:
{
Description: Author email. ,
Required: False ,
}
string ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: True if deployment is currently active, false if completed and null if not started. ,
Required: False ,
}
boolean ,
details:
{
Description: Details on deployment. ,
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 ,
}
,
}
WebApps_GetDeploymentSlot (new)
Description :  Description for Get a deployment by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
id:
{
Description: Deployment ID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot. ,
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: Deployment resource specific properties ,
Required: False ,
}
{
status:
{
Description: Deployment status. ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Details about deployment status. ,
Required: False ,
}
string ,
author:
{
Description: Who authored the deployment. ,
Required: False ,
}
string ,
deployer:
{
Description: Who performed the deployment. ,
Required: False ,
}
string ,
author_email:
{
Description: Author email. ,
Required: False ,
}
string ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: True if deployment is currently active, false if completed and null if not started. ,
Required: False ,
}
boolean ,
details:
{
Description: Details on deployment. ,
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 ,
}
,
}
WebApps_CreateDeploymentSlot (new)
Description :  Description for Create a deployment for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
id:
{
Description: ID of an existing deployment. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot. ,
Required: True ,
}
string ,
deployment:
{
Description: Deployment details. ,
Required: True ,
}
{
properties:
{
Description: Deployment resource specific properties ,
Required: False ,
}
{
status:
{
Description: Deployment status. ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Details about deployment status. ,
Required: False ,
}
string ,
author:
{
Description: Who authored the deployment. ,
Required: False ,
}
string ,
deployer:
{
Description: Who performed the deployment. ,
Required: False ,
}
string ,
author_email:
{
Description: Author email. ,
Required: False ,
}
string ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: True if deployment is currently active, false if completed and null if not started. ,
Required: False ,
}
boolean ,
details:
{
Description: Details on deployment. ,
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: Deployment resource specific properties ,
Required: False ,
}
{
status:
{
Description: Deployment status. ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Details about deployment status. ,
Required: False ,
}
string ,
author:
{
Description: Who authored the deployment. ,
Required: False ,
}
string ,
deployer:
{
Description: Who performed the deployment. ,
Required: False ,
}
string ,
author_email:
{
Description: Author email. ,
Required: False ,
}
string ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: True if deployment is currently active, false if completed and null if not started. ,
Required: False ,
}
boolean ,
details:
{
Description: Details on deployment. ,
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 ,
}
,
}
WebApps_DeleteDeploymentSlot (new)
Description :  Description for Delete a deployment by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
id:
{
Description: Deployment ID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ,
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 ,
}
,
}
WebApps_ListDeploymentLogSlot (new)
Description :  Description for List deployment log for specific deployment for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
id:
{
Description: The ID of a specific deployment. This is the value of the name property in the JSON response from "GET /api/sites/{siteName}/deployments". ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
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: Deployment resource specific properties ,
Required: False ,
}
{
status:
{
Description: Deployment status. ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Details about deployment status. ,
Required: False ,
}
string ,
author:
{
Description: Who authored the deployment. ,
Required: False ,
}
string ,
deployer:
{
Description: Who performed the deployment. ,
Required: False ,
}
string ,
author_email:
{
Description: Author email. ,
Required: False ,
}
string ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: True if deployment is currently active, false if completed and null if not started. ,
Required: False ,
}
boolean ,
details:
{
Description: Details on deployment. ,
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 ,
}
,
}
WebApps_DiscoverBackupSlot (new)
Description :  Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
request:
{
Description: A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup. ,
Required: True ,
}
{
properties:
{
Description: RestoreRequest resource specific properties ,
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup. ,
Required: False ,
}
string ,
overwrite:
{
Description: true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. ,
Required: True ,
}
boolean ,
siteName:
{
Description: Name of an app. ,
Required: False ,
}
string ,
databases:
{
Description: Collection of databases which should be restored. This list has to match the list of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
ignoreConflictingHostNames:
{
Description: Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
ignoreDatabases:
{
Description: Ignore the databases and only restore the site content ,
Required: False ,
}
boolean ,
appServicePlan:
{
Description: Specify app service plan that will own restored site. ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
Snapshot: No description available. ,
CloudFS: No description available. ,
}
,
Required: False ,
}
enum ,
adjustConnectionStrings:
{
Description: true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false. ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring an app to an App Service Environment). ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot. ,
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: RestoreRequest resource specific properties ,
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup. ,
Required: False ,
}
string ,
overwrite:
{
Description: true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. ,
Required: True ,
}
boolean ,
siteName:
{
Description: Name of an app. ,
Required: False ,
}
string ,
databases:
{
Description: Collection of databases which should be restored. This list has to match the list of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
ignoreConflictingHostNames:
{
Description: Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
ignoreDatabases:
{
Description: Ignore the databases and only restore the site content ,
Required: False ,
}
boolean ,
appServicePlan:
{
Description: Specify app service plan that will own restored site. ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
Snapshot: No description available. ,
CloudFS: No description available. ,
}
,
Required: False ,
}
enum ,
adjustConnectionStrings:
{
Description: true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false. ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring an app to an App Service Environment). ,
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 ,
}
,
}
WebApps_ListDomainOwnershipIdentifiersSlot (new)
Description :  Description for Lists ownership identifiers for domain associated with web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. ,
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: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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 ,
}
,
}
WebApps_GetDomainOwnershipIdentifierSlot (new)
Description :  Description for Get domain ownership identifier for web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
domainOwnershipIdentifierName:
{
Description: Name of domain ownership identifier. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. ,
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: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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 ,
}
,
}
WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot (new)
Description :  Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
domainOwnershipIdentifierName:
{
Description: Name of domain ownership identifier. ,
Required: True ,
}
string ,
domainOwnershipIdentifier:
{
Description: A JSON representation of the domain ownership properties. ,
Required: True ,
}
{
properties:
{
Description: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. ,
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: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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 ,
}
,
}
WebApps_DeleteDomainOwnershipIdentifierSlot (new)
Description :  Description for Deletes a domain ownership identifier for a web app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
domainOwnershipIdentifierName:
{
Description: Name of domain ownership identifier. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. ,
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 ,
}
,
}
WebApps_UpdateDomainOwnershipIdentifierSlot (new)
Description :  Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
domainOwnershipIdentifierName:
{
Description: Name of domain ownership identifier. ,
Required: True ,
}
string ,
domainOwnershipIdentifier:
{
Description: A JSON representation of the domain ownership properties. ,
Required: True ,
}
{
properties:
{
Description: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. ,
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: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
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 ,
}
,
}
WebApps_GetMSDeployStatusSlot (new)
Description :  Description for Get the status of the last MSDeploy operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: MSDeployStatus resource specific properties ,
Required: False ,
}
{
deployer:
{
Description: Username of deployer ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
accepted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
complete:
{
Description: Whether the deployment operation has completed ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateMSDeployOperationSlot (new)
Description :  Description for Invoke the MSDeploy web app extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
MSDeploy:
{
Description: Details of MSDeploy operation ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
addOnPackages:
{
Description: List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule. ,
Required: False ,
}
[
{
packageUri:
{
Description: Package URI ,
Required: False ,
}
string ,
connectionString:
{
Description: SQL Connection String ,
Required: False ,
}
string ,
dbType:
{
Description: Database Type ,
Required: False ,
}
string ,
setParametersXmlFileUri:
{
Description: URI of MSDeploy Parameters file. Must not be set if SetParameters is used. ,
Required: False ,
}
string ,
setParameters:
{
Description: MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. ,
Required: False ,
}
object ,
skipAppData:
{
Description: Controls whether the MSDeploy operation skips the App_Data directory. If set to true, the existing App_Data directory on the destination will not be deleted, and any App_Data directory in the source will be ignored. Setting is false by default. ,
Required: False ,
}
boolean ,
appOffline:
{
Description: Sets the AppOffline rule while the MSDeploy operation executes. Setting is false by default. ,
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 (201)

{
properties:
{
Description: MSDeployStatus resource specific properties ,
Required: False ,
}
{
deployer:
{
Description: Username of deployer ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
accepted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
complete:
{
Description: Whether the deployment operation has completed ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (409)

{}

⚐ 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 ,
}
,
}
WebApps_GetMSDeployLogSlot (new)
Description :  Description for Get the MSDeploy Log for the last MSDeploy operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: MSDeployLog resource specific properties ,
Required: False ,
}
{
entries:
{
Description: List of log entry messages ,
Required: False ,
}
[
{
time:
{
Description: Timestamp of log entry ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Log entry type ,
Enum:
{
Message: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Log entry message ,
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 ,
}
,
}
WebApps_ListInstanceFunctionsSlot (new)
Description :  Description for List the functions for a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
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: FunctionEnvelope resource specific properties ,
Required: False ,
}
{
function_app_id:
{
Description: Function App ID. ,
Required: False ,
}
string ,
script_root_path_href:
{
Description: Script root path URI. ,
Required: False ,
}
string ,
script_href:
{
Description: Script URI. ,
Required: False ,
}
string ,
config_href:
{
Description: Config URI. ,
Required: False ,
}
string ,
test_data_href:
{
Description: Test data URI. ,
Required: False ,
}
string ,
secrets_file_href:
{
Description: Secrets file URI. ,
Required: False ,
}
string ,
href:
{
Description: Function URI. ,
Required: False ,
}
string ,
config:
{
Description: Config information. ,
Required: False ,
}
object ,
files:
{
Description: File list. ,
Required: False ,
}
object ,
test_data:
{
Description: Test data used when testing via the Azure Portal. ,
Required: False ,
}
string ,
invoke_url_template:
{
Description: The invocation URL ,
Required: False ,
}
string ,
language:
{
Description: The function language ,
Required: False ,
}
string ,
isDisabled:
{
Description: Gets or sets a value indicating whether the function is disabled ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetFunctionsAdminTokenSlot (new)
Description :  Description for Fetch a short lived token that can be exchanged for a master key.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: 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 ,
}
,
}
WebApps_GetInstanceFunctionSlot (new)
Description :  Description for Get function information by its ID for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: Function name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
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: FunctionEnvelope resource specific properties ,
Required: False ,
}
{
function_app_id:
{
Description: Function App ID. ,
Required: False ,
}
string ,
script_root_path_href:
{
Description: Script root path URI. ,
Required: False ,
}
string ,
script_href:
{
Description: Script URI. ,
Required: False ,
}
string ,
config_href:
{
Description: Config URI. ,
Required: False ,
}
string ,
test_data_href:
{
Description: Test data URI. ,
Required: False ,
}
string ,
secrets_file_href:
{
Description: Secrets file URI. ,
Required: False ,
}
string ,
href:
{
Description: Function URI. ,
Required: False ,
}
string ,
config:
{
Description: Config information. ,
Required: False ,
}
object ,
files:
{
Description: File list. ,
Required: False ,
}
object ,
test_data:
{
Description: Test data used when testing via the Azure Portal. ,
Required: False ,
}
string ,
invoke_url_template:
{
Description: The invocation URL ,
Required: False ,
}
string ,
language:
{
Description: The function language ,
Required: False ,
}
string ,
isDisabled:
{
Description: Gets or sets a value indicating whether the function is disabled ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateInstanceFunctionSlot (new)
Description :  Description for Create function for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: Function name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
Required: True ,
}
string ,
function_envelope:
{
Description: Function details. ,
Required: True ,
}
{
properties:
{
Description: FunctionEnvelope resource specific properties ,
Required: False ,
}
{
function_app_id:
{
Description: Function App ID. ,
Required: False ,
}
string ,
script_root_path_href:
{
Description: Script root path URI. ,
Required: False ,
}
string ,
script_href:
{
Description: Script URI. ,
Required: False ,
}
string ,
config_href:
{
Description: Config URI. ,
Required: False ,
}
string ,
test_data_href:
{
Description: Test data URI. ,
Required: False ,
}
string ,
secrets_file_href:
{
Description: Secrets file URI. ,
Required: False ,
}
string ,
href:
{
Description: Function URI. ,
Required: False ,
}
string ,
config:
{
Description: Config information. ,
Required: False ,
}
object ,
files:
{
Description: File list. ,
Required: False ,
}
object ,
test_data:
{
Description: Test data used when testing via the Azure Portal. ,
Required: False ,
}
string ,
invoke_url_template:
{
Description: The invocation URL ,
Required: False ,
}
string ,
language:
{
Description: The function language ,
Required: False ,
}
string ,
isDisabled:
{
Description: Gets or sets a value indicating whether the function is disabled ,
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 (201)

{
properties:
{
Description: FunctionEnvelope resource specific properties ,
Required: False ,
}
{
function_app_id:
{
Description: Function App ID. ,
Required: False ,
}
string ,
script_root_path_href:
{
Description: Script root path URI. ,
Required: False ,
}
string ,
script_href:
{
Description: Script URI. ,
Required: False ,
}
string ,
config_href:
{
Description: Config URI. ,
Required: False ,
}
string ,
test_data_href:
{
Description: Test data URI. ,
Required: False ,
}
string ,
secrets_file_href:
{
Description: Secrets file URI. ,
Required: False ,
}
string ,
href:
{
Description: Function URI. ,
Required: False ,
}
string ,
config:
{
Description: Config information. ,
Required: False ,
}
object ,
files:
{
Description: File list. ,
Required: False ,
}
object ,
test_data:
{
Description: Test data used when testing via the Azure Portal. ,
Required: False ,
}
string ,
invoke_url_template:
{
Description: The invocation URL ,
Required: False ,
}
string ,
language:
{
Description: The function language ,
Required: False ,
}
string ,
isDisabled:
{
Description: Gets or sets a value indicating whether the function is disabled ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteInstanceFunctionSlot (new)
Description :  Description for Delete a function for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateFunctionSecretSlot (new)
Description :  Description for Add or update a function secret.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: The name of the function. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
Required: True ,
}
string ,
key:
{
Description: The key to create or update ,
Required: True ,
}
{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
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 (201)

{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
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 ,
}
,
}
WebApps_DeleteFunctionSecretSlot (new)
Description :  Description for Delete a function secret.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: The name of the function. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
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 (404)

{}

⚐ 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 ,
}
,
}
WebApps_ListFunctionKeysSlot (new)
Description :  Description for Get function keys for a function in a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: Function name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
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: Settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListFunctionSecretsSlot (new)
Description :  Description for Get function secrets for a function in a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
functionName:
{
Description: Function name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
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)

{
key:
{
Description: Secret key. ,
Required: False ,
}
string ,
trigger_url:
{
Description: Trigger URL. ,
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 ,
}
,
}
WebApps_ListHostKeysSlot (new)
Description :  Description for Get host secrets for a function app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
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)

{
masterKey:
{
Description: Secret key. ,
Required: False ,
}
string ,
functionKeys:
{
Description: Host level function keys. ,
Required: False ,
}
object ,
systemKeys:
{
Description: System keys. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListSyncStatusSlot (new)
Description :  Description for This is to allow calling via powershell and ARM template.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_SyncFunctionsSlot (new)
Description :  Description for Syncs function trigger metadata to the management database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/sync
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateHostSecretSlot (new)
Description :  Description for Add or update a host level secret.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
keyType:
{
Description: The type of host key. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
Required: True ,
}
string ,
key:
{
Description: The key to create or update ,
Required: True ,
}
{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
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 (201)

{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Key name ,
Required: False ,
}
string ,
value:
{
Description: Key value ,
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 ,
}
,
}
WebApps_DeleteHostSecretSlot (new)
Description :  Description for Delete a host level secret.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
keyType:
{
Description: The type of host key. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
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 (404)

{}

⚐ 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 ,
}
,
}
WebApps_ListHostNameBindingsSlot (new)
Description :  Description for Get hostname bindings for an app or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot. ,
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: HostNameBinding resource specific properties ,
Required: False ,
}
{
siteName:
{
Description: App Service app name. ,
Required: False ,
}
string ,
domainId:
{
Description: Fully qualified ARM domain resource URI. ,
Required: False ,
}
string ,
azureResourceName:
{
Description: Azure resource name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Azure resource type. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Custom DNS record type. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Hostname type. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: SSL certificate thumbprint ,
Required: False ,
}
string ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
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 ,
}
,
}
WebApps_GetHostNameBindingSlot (new)
Description :  Description for Get the named hostname binding for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot. ,
Required: True ,
}
string ,
hostName:
{
Description: Hostname in the hostname binding. ,
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: HostNameBinding resource specific properties ,
Required: False ,
}
{
siteName:
{
Description: App Service app name. ,
Required: False ,
}
string ,
domainId:
{
Description: Fully qualified ARM domain resource URI. ,
Required: False ,
}
string ,
azureResourceName:
{
Description: Azure resource name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Azure resource type. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Custom DNS record type. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Hostname type. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: SSL certificate thumbprint ,
Required: False ,
}
string ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
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 ,
}
,
}
WebApps_CreateOrUpdateHostNameBindingSlot (new)
Description :  Description for Creates a hostname binding for an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
hostName:
{
Description: Hostname in the hostname binding. ,
Required: True ,
}
string ,
hostNameBinding:
{
Description: Binding details. This is the JSON representation of a HostNameBinding object. ,
Required: True ,
}
{
properties:
{
Description: HostNameBinding resource specific properties ,
Required: False ,
}
{
siteName:
{
Description: App Service app name. ,
Required: False ,
}
string ,
domainId:
{
Description: Fully qualified ARM domain resource URI. ,
Required: False ,
}
string ,
azureResourceName:
{
Description: Azure resource name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Azure resource type. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Custom DNS record type. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Hostname type. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: SSL certificate thumbprint ,
Required: False ,
}
string ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. ,
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: HostNameBinding resource specific properties ,
Required: False ,
}
{
siteName:
{
Description: App Service app name. ,
Required: False ,
}
string ,
domainId:
{
Description: Fully qualified ARM domain resource URI. ,
Required: False ,
}
string ,
azureResourceName:
{
Description: Azure resource name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Azure resource type. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Custom DNS record type. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Hostname type. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: SSL certificate thumbprint ,
Required: False ,
}
string ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
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 ,
}
,
}
WebApps_DeleteHostNameBindingSlot (new)
Description :  Description for Deletes a hostname binding for an app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. ,
Required: True ,
}
string ,
hostName:
{
Description: Hostname in the hostname binding. ,
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 ,
}
,
}
WebApps_GetHybridConnectionSlot (new)
Description :  Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace for this hybrid connection. ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name for this hybrid connection. ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for the web app. ,
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 ,
}
,
}
WebApps_CreateOrUpdateHybridConnectionSlot (new)
Description :  Description for Creates a new Hybrid Connection using a Service Bus relay.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace for this hybrid connection. ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name for this hybrid connection. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the hybrid connection. ,
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 ,
}
,
}
,
slot:
{
Description: The name of the slot for the web app. ,
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 ,
}
,
}
WebApps_DeleteHybridConnectionSlot (new)
Description :  Description for Removes a Hybrid Connection from this site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace for this hybrid connection. ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name for this hybrid connection. ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for the web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateHybridConnectionSlot (new)
Description :  Description for Creates a new Hybrid Connection using a Service Bus relay.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace for this hybrid connection. ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name for this hybrid connection. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the hybrid connection. ,
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 ,
}
,
}
,
slot:
{
Description: The name of the slot for the web app. ,
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 ,
}
,
}
WebApps_ListHybridConnectionsSlot (new)
Description :  Description for Retrieves all Service Bus Hybrid Connections used by this Web App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for the web app. ,
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 ,
}
,
}
WebApps_ListRelayServiceConnectionsSlot (new)
Description :  Description for Gets hybrid connections configured for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get hybrid connections for the production slot. ,
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: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
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 ,
}
,
}
WebApps_GetRelayServiceConnectionSlot (new)
Description :  Description for Gets a hybrid connection configuration by its name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
entityName:
{
Description: Name of the hybrid connection. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot. ,
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: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
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 ,
}
,
}
WebApps_CreateOrUpdateRelayServiceConnectionSlot (new)
Description :  Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
entityName:
{
Description: Name of the hybrid connection configuration. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Details of the hybrid connection configuration. ,
Required: True ,
}
{
properties:
{
Description: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot. ,
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: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
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 ,
}
,
}
WebApps_DeleteRelayServiceConnectionSlot (new)
Description :  Description for Deletes a relay service connection by its name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
entityName:
{
Description: Name of the hybrid connection configuration. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete a hybrid connection for the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateRelayServiceConnectionSlot (new)
Description :  Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
entityName:
{
Description: Name of the hybrid connection configuration. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Details of the hybrid connection configuration. ,
Required: True ,
}
{
properties:
{
Description: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot. ,
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: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
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 ,
}
,
}
WebApps_ListInstanceIdentifiersSlot (new)
Description :  Description for Gets all scale-out instances of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API gets the production slot instances. ,
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: WebSiteInstanceStatus resource specific properties ,
Required: False ,
}
{
state:
{
Enum:
{
READY: No description available. ,
STOPPED: No description available. ,
UNKNOWN: No description available. ,
}
,
Required: False ,
}
enum ,
statusUrl:
{
Description: Link to the GetStatusApi in Kudu ,
Required: False ,
}
string ,
detectorUrl:
{
Description: Link to the Diagnose and Solve Portal ,
Required: False ,
}
string ,
consoleUrl:
{
Description: Link to the console to web app instance ,
Required: False ,
}
string ,
healthCheckUrl:
{
Description: Link to the console to web app instance ,
Required: False ,
}
string ,
containers:
{
Required: False ,
}
object ,
physicalZone:
{
Description: The physical zone that the instance is in ,
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 ,
}
,
}
WebApps_GetInstanceInfoSlot (new)
Description :  Description for Gets all scale-out instances of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
instanceId:
{
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API gets the production slot instances. ,
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: WebSiteInstanceStatus resource specific properties ,
Required: False ,
}
{
state:
{
Enum:
{
READY: No description available. ,
STOPPED: No description available. ,
UNKNOWN: No description available. ,
}
,
Required: False ,
}
enum ,
statusUrl:
{
Description: Link to the GetStatusApi in Kudu ,
Required: False ,
}
string ,
detectorUrl:
{
Description: Link to the Diagnose and Solve Portal ,
Required: False ,
}
string ,
consoleUrl:
{
Description: Link to the console to web app instance ,
Required: False ,
}
string ,
healthCheckUrl:
{
Description: Link to the console to web app instance ,
Required: False ,
}
string ,
containers:
{
Required: False ,
}
object ,
physicalZone:
{
Description: The physical zone that the instance is in ,
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 ,
}
,
}
WebApps_GetInstanceMsDeployStatusSlot (new)
Description :  Description for Get the status of the last MSDeploy operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of web app instance. ,
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: MSDeployStatus resource specific properties ,
Required: False ,
}
{
deployer:
{
Description: Username of deployer ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
accepted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
complete:
{
Description: Whether the deployment operation has completed ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateInstanceMSDeployOperationSlot (new)
Description :  Description for Invoke the MSDeploy web app extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of web app instance. ,
Required: True ,
}
string ,
MSDeploy:
{
Description: Details of MSDeploy operation ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
addOnPackages:
{
Description: List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule. ,
Required: False ,
}
[
{
packageUri:
{
Description: Package URI ,
Required: False ,
}
string ,
connectionString:
{
Description: SQL Connection String ,
Required: False ,
}
string ,
dbType:
{
Description: Database Type ,
Required: False ,
}
string ,
setParametersXmlFileUri:
{
Description: URI of MSDeploy Parameters file. Must not be set if SetParameters is used. ,
Required: False ,
}
string ,
setParameters:
{
Description: MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. ,
Required: False ,
}
object ,
skipAppData:
{
Description: Controls whether the MSDeploy operation skips the App_Data directory. If set to true, the existing App_Data directory on the destination will not be deleted, and any App_Data directory in the source will be ignored. Setting is false by default. ,
Required: False ,
}
boolean ,
appOffline:
{
Description: Sets the AppOffline rule while the MSDeploy operation executes. Setting is false by default. ,
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 (201)

{
properties:
{
Description: MSDeployStatus resource specific properties ,
Required: False ,
}
{
deployer:
{
Description: Username of deployer ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
accepted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of deploy operation ,
Format: date-time ,
Required: False ,
}
string ,
complete:
{
Description: Whether the deployment operation has completed ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (409)

{}

⚐ 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 ,
}
,
}
WebApps_GetInstanceMSDeployLogSlot (new)
Description :  Description for Get the MSDeploy Log for the last MSDeploy operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of web app instance. ,
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: MSDeployLog resource specific properties ,
Required: False ,
}
{
entries:
{
Description: List of log entry messages ,
Required: False ,
}
[
{
time:
{
Description: Timestamp of log entry ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Log entry type ,
Enum:
{
Message: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Log entry message ,
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 ,
}
,
}
WebApps_ListInstanceProcessesSlot (new)
Description :  Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: ProcessInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: ARM Identifier for deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
deployment_name:
{
Description: Deployment name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
minidump:
{
Description: Minidump URI. ,
Required: False ,
}
string ,
is_profile_running:
{
Description: Is profile running? ,
Required: False ,
}
boolean ,
is_iis_profile_running:
{
Description: Is the IIS Profile running? ,
Required: False ,
}
boolean ,
iis_profile_timeout_in_seconds:
{
Description: IIS Profile timeout (seconds). ,
Format: double ,
Required: False ,
}
number ,
parent:
{
Description: Parent process. ,
Required: False ,
}
string ,
children:
{
Description: Child process list. ,
Required: False ,
}
[
string ,
]
,
threads:
{
Description: Thread list. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
open_file_handles:
{
Description: List of open files. ,
Required: False ,
}
[
string ,
]
,
modules:
{
Description: List of modules. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
file_name:
{
Description: File name of this process. ,
Required: False ,
}
string ,
command_line:
{
Description: Command line. ,
Required: False ,
}
string ,
user_name:
{
Description: User name. ,
Required: False ,
}
string ,
handle_count:
{
Description: Handle count. ,
Format: int32 ,
Required: False ,
}
integer ,
module_count:
{
Description: Module count. ,
Format: int32 ,
Required: False ,
}
integer ,
thread_count:
{
Description: Thread count. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_cpu_time:
{
Description: Total CPU time. ,
Required: False ,
}
string ,
user_cpu_time:
{
Description: User CPU time. ,
Required: False ,
}
string ,
privileged_cpu_time:
{
Description: Privileged CPU time. ,
Required: False ,
}
string ,
working_set:
{
Description: Working set. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_working_set:
{
Description: Peak working set. ,
Format: int64 ,
Required: False ,
}
integer ,
private_memory:
{
Description: Private memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
virtual_memory:
{
Description: Virtual memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_virtual_memory:
{
Description: Peak virtual memory usage. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_system_memory:
{
Description: Paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
non_paged_system_memory:
{
Description: Non-paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_memory:
{
Description: Paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_paged_memory:
{
Description: Peak paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
time_stamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
environment_variables:
{
Description: List of environment variables. ,
Required: False ,
}
object ,
is_scm_site:
{
Description: Is this the SCM site? ,
Required: False ,
}
boolean ,
is_webjob:
{
Description: Is this a Web Job? ,
Required: False ,
}
boolean ,
description:
{
Description: Description of process. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetInstanceProcessSlot (new)
Description :  Description for Get process information by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: ProcessInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: ARM Identifier for deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
deployment_name:
{
Description: Deployment name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
minidump:
{
Description: Minidump URI. ,
Required: False ,
}
string ,
is_profile_running:
{
Description: Is profile running? ,
Required: False ,
}
boolean ,
is_iis_profile_running:
{
Description: Is the IIS Profile running? ,
Required: False ,
}
boolean ,
iis_profile_timeout_in_seconds:
{
Description: IIS Profile timeout (seconds). ,
Format: double ,
Required: False ,
}
number ,
parent:
{
Description: Parent process. ,
Required: False ,
}
string ,
children:
{
Description: Child process list. ,
Required: False ,
}
[
string ,
]
,
threads:
{
Description: Thread list. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
open_file_handles:
{
Description: List of open files. ,
Required: False ,
}
[
string ,
]
,
modules:
{
Description: List of modules. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
file_name:
{
Description: File name of this process. ,
Required: False ,
}
string ,
command_line:
{
Description: Command line. ,
Required: False ,
}
string ,
user_name:
{
Description: User name. ,
Required: False ,
}
string ,
handle_count:
{
Description: Handle count. ,
Format: int32 ,
Required: False ,
}
integer ,
module_count:
{
Description: Module count. ,
Format: int32 ,
Required: False ,
}
integer ,
thread_count:
{
Description: Thread count. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_cpu_time:
{
Description: Total CPU time. ,
Required: False ,
}
string ,
user_cpu_time:
{
Description: User CPU time. ,
Required: False ,
}
string ,
privileged_cpu_time:
{
Description: Privileged CPU time. ,
Required: False ,
}
string ,
working_set:
{
Description: Working set. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_working_set:
{
Description: Peak working set. ,
Format: int64 ,
Required: False ,
}
integer ,
private_memory:
{
Description: Private memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
virtual_memory:
{
Description: Virtual memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_virtual_memory:
{
Description: Peak virtual memory usage. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_system_memory:
{
Description: Paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
non_paged_system_memory:
{
Description: Non-paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_memory:
{
Description: Paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_paged_memory:
{
Description: Peak paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
time_stamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
environment_variables:
{
Description: List of environment variables. ,
Required: False ,
}
object ,
is_scm_site:
{
Description: Is this the SCM site? ,
Required: False ,
}
boolean ,
is_webjob:
{
Description: Is this a Web Job? ,
Required: False ,
}
boolean ,
description:
{
Description: Description of process. ,
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 ,
}
,
}
WebApps_DeleteInstanceProcessSlot (new)
Description :  Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_GetInstanceProcessDumpSlot (new)
Description :  Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: file ,
}

⚐ 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 ,
}
,
}
WebApps_ListInstanceProcessModulesSlot (new)
Description :  Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetInstanceProcessModuleSlot (new)
Description :  Description for Get process information by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
baseAddress:
{
Description: Module base address. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
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 ,
}
,
}
WebApps_ListInstanceProcessThreadsSlot (new)
Description :  Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
Required: True ,
}
string ,
instanceId:
{
Description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". ,
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: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_IsCloneableSlot (new)
Description :  Description for Shows whether an app can be cloned to another resource group or subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. By default, this API returns information on the production slot. ,
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)

{
result:
{
Description: Name of app. ,
Enum:
{
Cloneable: No description available. ,
PartiallyCloneable: No description available. ,
NotCloneable: No description available. ,
}
,
Required: False ,
}
enum ,
blockingFeatures:
{
Description: List of features enabled on app that prevent cloning. ,
Required: False ,
}
[
{
name:
{
Description: Name of criterion. ,
Required: False ,
}
string ,
description:
{
Description: Description of criterion. ,
Required: False ,
}
string ,
}
,
]
,
unsupportedFeatures:
{
Description: List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned but the features in this list will not be set up on cloned app. ,
Required: False ,
}
[
{
name:
{
Description: Name of criterion. ,
Required: False ,
}
string ,
description:
{
Description: Description of criterion. ,
Required: False ,
}
string ,
}
,
]
,
blockingCharacteristics:
{
Description: List of blocking application characteristics. ,
Required: False ,
}
[
{
name:
{
Description: Name of criterion. ,
Required: False ,
}
string ,
description:
{
Description: Description of criterion. ,
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 ,
}
,
}
WebApps_ListSiteBackupsSlot (new)
Description :  Description for Gets existing backups of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listbackups
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot. ,
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: BackupItem resource specific properties ,
Required: False ,
}
{
id:
{
Description: Id of the backup. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccountUrl:
{
Description: SAS URL for the storage account container which contains this backup. ,
Required: False ,
}
string ,
blobName:
{
Description: Name of the blob which contains data for this backup. ,
Required: False ,
}
string ,
name:
{
Description: Name of this backup. ,
Required: False ,
}
string ,
status:
{
Description: Backup status. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
Skipped: No description available. ,
PartiallySucceeded: No description available. ,
DeleteInProgress: No description available. ,
DeleteFailed: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
sizeInBytes:
{
Description: Size of the backup in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: Timestamp of the backup creation. ,
Format: date-time ,
Required: False ,
}
string ,
log:
{
Description: Details regarding this backup. Might contain an error message. ,
Required: False ,
}
string ,
databases:
{
Description: List of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
scheduled:
{
Description: True if this backup has been created due to a schedule being triggered. ,
Required: False ,
}
boolean ,
lastRestoreTimeStamp:
{
Description: Timestamp of a last restore operation which used this backup. ,
Format: date-time ,
Required: False ,
}
string ,
finishedTimeStamp:
{
Description: Timestamp when this backup finished. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. ,
Required: False ,
}
string ,
websiteSizeInBytes:
{
Description: Size of the original web app which has been backed up. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_ListSyncFunctionTriggersSlot (new)
Description :  Description for This is to allow calling via powershell and ARM template.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
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)

{
key:
{
Description: Secret key. ,
Required: False ,
}
string ,
trigger_url:
{
Description: Trigger URL. ,
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 ,
}
,
}
WebApps_GetMigrateMySqlStatusSlot (new)
Description :  Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
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: MigrateMySqlStatus resource specific properties ,
Required: False ,
}
{
migrationOperationStatus:
{
Description: Status of the migration task. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
operationId:
{
Description: Operation ID for the migration task. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: True if the web app has in app MySql enabled ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_GetSwiftVirtualNetworkConnectionSlot (new)
Description :  Description for Gets a Swift Virtual Network connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SwiftVirtualNetwork resource specific properties ,
Required: False ,
}
{
subnetResourceId:
{
Description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. ,
Required: False ,
}
string ,
swiftSupported:
{
Description: A flag that specifies if the scale unit this Web App is on supports Swift integration. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionWithCheckSlot (new)
Description :  Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Properties of the Virtual Network connection. See example. ,
Required: True ,
}
{
properties:
{
Description: SwiftVirtualNetwork resource specific properties ,
Required: False ,
}
{
subnetResourceId:
{
Description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. ,
Required: False ,
}
string ,
swiftSupported:
{
Description: A flag that specifies if the scale unit this Web App is on supports Swift integration. ,
Required: False ,
}
boolean ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot. ,
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: SwiftVirtualNetwork resource specific properties ,
Required: False ,
}
{
subnetResourceId:
{
Description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. ,
Required: False ,
}
string ,
swiftSupported:
{
Description: A flag that specifies if the scale unit this Web App is on supports Swift integration. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteSwiftVirtualNetworkSlot (new)
Description :  Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateSwiftVirtualNetworkConnectionWithCheckSlot (new)
Description :  Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Properties of the Virtual Network connection. See example. ,
Required: True ,
}
{
properties:
{
Description: SwiftVirtualNetwork resource specific properties ,
Required: False ,
}
{
subnetResourceId:
{
Description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. ,
Required: False ,
}
string ,
swiftSupported:
{
Description: A flag that specifies if the scale unit this Web App is on supports Swift integration. ,
Required: False ,
}
boolean ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot. ,
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: SwiftVirtualNetwork resource specific properties ,
Required: False ,
}
{
subnetResourceId:
{
Description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. ,
Required: False ,
}
string ,
swiftSupported:
{
Description: A flag that specifies if the scale unit this Web App is on supports Swift integration. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListNetworkFeaturesSlot (new)
Description :  Description for Gets all network features used by the app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
view:
{
Description: The type of view. Only "summary" is supported at this time. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot. ,
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: NetworkFeatures resource specific properties ,
Required: False ,
}
{
virtualNetworkName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
virtualNetworkConnection:
{
Description: The Virtual Network summary view. ,
Required: False ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
Required: False ,
}
boolean ,
}
,
hybridConnections:
{
Description: The Hybrid Connections summary view. ,
Required: False ,
}
[
{
properties:
{
Description: RelayServiceConnectionEntity resource specific properties ,
Required: False ,
}
{
entityName:
{
Required: False ,
}
string ,
entityConnectionString:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
resourceConnectionString:
{
Required: False ,
}
string ,
hostname:
{
Required: False ,
}
string ,
port:
{
Format: int32 ,
Required: False ,
}
integer ,
biztalkUri:
{
Required: False ,
}
string ,
}
,
}
,
]
,
hybridConnectionsV2:
{
Description: The Hybrid Connection V2 (Service Bus) view. ,
Required: False ,
}
[
{
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 (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 ,
}
,
}
WebApps_GetNetworkTraceOperationSlot (new)
Description :  Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
operationId:
{
Description: GUID of the operation. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_StartWebSiteNetworkTraceSlot (new)
Description :  Description for Start capturing network packets for the site (To be deprecated).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
durationInSeconds:
{
Description: The duration to keep capturing in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
maxFrameLength:
{
Description: The maximum frame length in bytes (Optional). ,
Format: int32 ,
Required: False ,
}
integer ,
sasUrl:
{
Description: The Blob URL to store capture file. ,
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)

{
$schema: 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 ,
}
,
}
WebApps_StartWebSiteNetworkTraceOperationSlot (new)
Description :  Description for Start capturing network packets for the site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/startOperation
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
durationInSeconds:
{
Description: The duration to keep capturing in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
maxFrameLength:
{
Description: The maximum frame length in bytes (Optional). ,
Format: int32 ,
Required: False ,
}
integer ,
sasUrl:
{
Description: The Blob URL to store capture file. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_StopWebSiteNetworkTraceSlot (new)
Description :  Description for Stop ongoing capturing network packets for the site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for this web app. ,
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 ,
}
,
}
WebApps_GetNetworkTracesSlot (new)
Description :  Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
operationId:
{
Description: GUID of the operation. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_GetNetworkTraceOperationSlotV2 (new)
Description :  Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
operationId:
{
Description: GUID of the operation. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_GetNetworkTracesSlotV2 (new)
Description :  Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
operationId:
{
Description: GUID of the operation. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_GenerateNewSitePublishingPasswordSlot (new)
Description :  Description for Generates a new publishing password for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API generate a new publishing password for the production slot. ,
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 ,
}
,
}
WebApps_ListPerfMonCountersSlot (new)
Description :  Description for Gets perfmon counters for web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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=(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 ,
}
[
{
code:
{
Description: The response code. ,
Required: False ,
}
string ,
message:
{
Description: The message. ,
Required: False ,
}
string ,
data:
{
Description: The performance monitor counters. ,
Required: False ,
}
{
name:
{
Description: Unique key name of the counter. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the period. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the period. ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Presented time grain. ,
Required: False ,
}
string ,
values:
{
Description: Collection of workers that are active during this time. ,
Required: False ,
}
[
{
time:
{
Description: Point in time for which counter was measured. ,
Format: date-time ,
Required: False ,
}
string ,
instanceName:
{
Description: Name of the server on which the measurement is made. ,
Required: False ,
}
string ,
value:
{
Description: Value of counter at a certain time. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_GetSitePhpErrorLogFlagSlot (new)
Description :  Description for Gets web app's event logs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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: SitePhpErrorLogFlag resource specific properties ,
Required: False ,
}
{
localLogErrors:
{
Description: Local log_errors setting. ,
Required: False ,
}
string ,
masterLogErrors:
{
Description: Master log_errors setting. ,
Required: False ,
}
string ,
localLogErrorsMaxLength:
{
Description: Local log_errors_max_len setting. ,
Required: False ,
}
string ,
masterLogErrorsMaxLength:
{
Description: Master log_errors_max_len setting. ,
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 ,
}
,
}
WebApps_ListPremierAddOnsSlot (new)
Description :  Description for Gets the premier add-ons of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the premier add-ons for the production slot. ,
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: PremierAddOn resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
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 ,
}
,
}
WebApps_GetPremierAddOnSlot (new)
Description :  Description for Gets a named add-on of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
premierAddOnName:
{
Description: Add-on name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot. ,
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: PremierAddOn resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
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 ,
}
,
}
WebApps_AddPremierAddOnSlot (new)
Description :  Description for Updates a named add-on of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
premierAddOnName:
{
Description: Add-on name. ,
Required: True ,
}
string ,
premierAddOn:
{
Description: A JSON representation of the edited premier add-on. ,
Required: True ,
}
{
properties:
{
Description: PremierAddOn resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot. ,
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: PremierAddOn resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
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 ,
}
,
}
WebApps_DeletePremierAddOnSlot (new)
Description :  Description for Delete a premier add-on from an app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
premierAddOnName:
{
Description: Add-on name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot. ,
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 ,
}
,
}
WebApps_UpdatePremierAddOnSlot (new)
Description :  Description for Updates a named add-on of an app.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
premierAddOnName:
{
Description: Add-on name. ,
Required: True ,
}
string ,
premierAddOn:
{
Description: A JSON representation of the edited premier add-on. ,
Required: True ,
}
{
properties:
{
Description: PremierAddOnPatchResource resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot. ,
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: PremierAddOn resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on Vendor. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Premier add on Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Premier add on Marketplace offer. ,
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 ,
}
,
}
WebApps_GetPrivateAccessSlot (new)
Description :  Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for the web app. ,
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: PrivateAccess resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: Whether private access is enabled or not. ,
Required: False ,
}
boolean ,
virtualNetworks:
{
Description: The Virtual Networks (and subnets) allowed to access the site privately. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Virtual Network. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the Virtual Network. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceId:
{
Description: The ARM uri of the Virtual Network ,
Required: False ,
}
string ,
subnets:
{
Description: A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. ,
Required: False ,
}
[
{
name:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the subnet. ,
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 ,
}
,
}
WebApps_PutPrivateAccessVnetSlot (new)
Description :  Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
access:
{
Description: The information for the private access ,
Required: True ,
}
{
properties:
{
Description: PrivateAccess resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: Whether private access is enabled or not. ,
Required: False ,
}
boolean ,
virtualNetworks:
{
Description: The Virtual Networks (and subnets) allowed to access the site privately. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Virtual Network. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the Virtual Network. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceId:
{
Description: The ARM uri of the Virtual Network ,
Required: False ,
}
string ,
subnets:
{
Description: A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. ,
Required: False ,
}
[
{
name:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}
,
slot:
{
Description: The name of the slot for the web app. ,
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: PrivateAccess resource specific properties ,
Required: False ,
}
{
enabled:
{
Description: Whether private access is enabled or not. ,
Required: False ,
}
boolean ,
virtualNetworks:
{
Description: The Virtual Networks (and subnets) allowed to access the site privately. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Virtual Network. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the Virtual Network. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceId:
{
Description: The ARM uri of the Virtual Network ,
Required: False ,
}
string ,
subnets:
{
Description: A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. ,
Required: False ,
}
[
{
name:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
key:
{
Description: The key (ID) of the subnet. ,
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 ,
}
,
}
WebApps_GetPrivateEndpointConnectionListSlot (new)
Description :  Description for Gets the list of private endpoint connections associated with a site
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the site deployment slot. ,
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 ,
}
,
}
WebApps_GetPrivateEndpointConnectionSlot (new)
Description :  Description for Gets a private endpoint connection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Name of the private endpoint connection. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the site deployment slot. ,
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 ,
}
,
}
WebApps_ApproveOrRejectPrivateEndpointConnectionSlot (new)
Description :  Description for Approves or rejects a private endpoint connection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
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 ,
]
,
}
,
}
,
slot:
{
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 (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 ,
}
,
}
WebApps_DeletePrivateEndpointConnectionSlot (new)
Description :  Description for Deletes a private endpoint connection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Required: True ,
}
string ,
slot:
{
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 ,
}
,
}
WebApps_GetPrivateLinkResourcesSlot (new)
Description :  Description for Gets the private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateLinkResources
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the site. ,
Required: True ,
}
string ,
slot:
{
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 ,
}
,
}
WebApps_ListProcessesSlot (new)
Description :  Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
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: ProcessInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: ARM Identifier for deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
deployment_name:
{
Description: Deployment name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
minidump:
{
Description: Minidump URI. ,
Required: False ,
}
string ,
is_profile_running:
{
Description: Is profile running? ,
Required: False ,
}
boolean ,
is_iis_profile_running:
{
Description: Is the IIS Profile running? ,
Required: False ,
}
boolean ,
iis_profile_timeout_in_seconds:
{
Description: IIS Profile timeout (seconds). ,
Format: double ,
Required: False ,
}
number ,
parent:
{
Description: Parent process. ,
Required: False ,
}
string ,
children:
{
Description: Child process list. ,
Required: False ,
}
[
string ,
]
,
threads:
{
Description: Thread list. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
open_file_handles:
{
Description: List of open files. ,
Required: False ,
}
[
string ,
]
,
modules:
{
Description: List of modules. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
file_name:
{
Description: File name of this process. ,
Required: False ,
}
string ,
command_line:
{
Description: Command line. ,
Required: False ,
}
string ,
user_name:
{
Description: User name. ,
Required: False ,
}
string ,
handle_count:
{
Description: Handle count. ,
Format: int32 ,
Required: False ,
}
integer ,
module_count:
{
Description: Module count. ,
Format: int32 ,
Required: False ,
}
integer ,
thread_count:
{
Description: Thread count. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_cpu_time:
{
Description: Total CPU time. ,
Required: False ,
}
string ,
user_cpu_time:
{
Description: User CPU time. ,
Required: False ,
}
string ,
privileged_cpu_time:
{
Description: Privileged CPU time. ,
Required: False ,
}
string ,
working_set:
{
Description: Working set. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_working_set:
{
Description: Peak working set. ,
Format: int64 ,
Required: False ,
}
integer ,
private_memory:
{
Description: Private memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
virtual_memory:
{
Description: Virtual memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_virtual_memory:
{
Description: Peak virtual memory usage. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_system_memory:
{
Description: Paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
non_paged_system_memory:
{
Description: Non-paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_memory:
{
Description: Paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_paged_memory:
{
Description: Peak paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
time_stamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
environment_variables:
{
Description: List of environment variables. ,
Required: False ,
}
object ,
is_scm_site:
{
Description: Is this the SCM site? ,
Required: False ,
}
boolean ,
is_webjob:
{
Description: Is this a Web Job? ,
Required: False ,
}
boolean ,
description:
{
Description: Description of process. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetProcessSlot (new)
Description :  Description for Get process information by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
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: ProcessInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: ARM Identifier for deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
deployment_name:
{
Description: Deployment name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
minidump:
{
Description: Minidump URI. ,
Required: False ,
}
string ,
is_profile_running:
{
Description: Is profile running? ,
Required: False ,
}
boolean ,
is_iis_profile_running:
{
Description: Is the IIS Profile running? ,
Required: False ,
}
boolean ,
iis_profile_timeout_in_seconds:
{
Description: IIS Profile timeout (seconds). ,
Format: double ,
Required: False ,
}
number ,
parent:
{
Description: Parent process. ,
Required: False ,
}
string ,
children:
{
Description: Child process list. ,
Required: False ,
}
[
string ,
]
,
threads:
{
Description: Thread list. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
open_file_handles:
{
Description: List of open files. ,
Required: False ,
}
[
string ,
]
,
modules:
{
Description: List of modules. ,
Required: False ,
}
[
{
properties:
{
Description: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
file_name:
{
Description: File name of this process. ,
Required: False ,
}
string ,
command_line:
{
Description: Command line. ,
Required: False ,
}
string ,
user_name:
{
Description: User name. ,
Required: False ,
}
string ,
handle_count:
{
Description: Handle count. ,
Format: int32 ,
Required: False ,
}
integer ,
module_count:
{
Description: Module count. ,
Format: int32 ,
Required: False ,
}
integer ,
thread_count:
{
Description: Thread count. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_cpu_time:
{
Description: Total CPU time. ,
Required: False ,
}
string ,
user_cpu_time:
{
Description: User CPU time. ,
Required: False ,
}
string ,
privileged_cpu_time:
{
Description: Privileged CPU time. ,
Required: False ,
}
string ,
working_set:
{
Description: Working set. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_working_set:
{
Description: Peak working set. ,
Format: int64 ,
Required: False ,
}
integer ,
private_memory:
{
Description: Private memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
virtual_memory:
{
Description: Virtual memory size. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_virtual_memory:
{
Description: Peak virtual memory usage. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_system_memory:
{
Description: Paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
non_paged_system_memory:
{
Description: Non-paged system memory. ,
Format: int64 ,
Required: False ,
}
integer ,
paged_memory:
{
Description: Paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
peak_paged_memory:
{
Description: Peak paged memory. ,
Format: int64 ,
Required: False ,
}
integer ,
time_stamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
environment_variables:
{
Description: List of environment variables. ,
Required: False ,
}
object ,
is_scm_site:
{
Description: Is this the SCM site? ,
Required: False ,
}
boolean ,
is_webjob:
{
Description: Is this a Web Job? ,
Required: False ,
}
boolean ,
description:
{
Description: Description of process. ,
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 ,
}
,
}
WebApps_DeleteProcessSlot (new)
Description :  Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_GetProcessDumpSlot (new)
Description :  Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
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: file ,
}

⚐ 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 ,
}
,
}
WebApps_ListProcessModulesSlot (new)
Description :  Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
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: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetProcessModuleSlot (new)
Description :  Description for Get process information by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
baseAddress:
{
Description: Module base address. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
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: ProcessModuleInfo resource specific properties ,
Required: False ,
}
{
base_address:
{
Description: Base address. Used as module identifier in ARM resource URI. ,
Required: False ,
}
string ,
file_name:
{
Description: File name. ,
Required: False ,
}
string ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
file_path:
{
Description: File path. ,
Required: False ,
}
string ,
module_memory_size:
{
Description: Module memory size. ,
Format: int32 ,
Required: False ,
}
integer ,
file_version:
{
Description: File version. ,
Required: False ,
}
string ,
file_description:
{
Description: File description. ,
Required: False ,
}
string ,
product:
{
Description: Product name. ,
Required: False ,
}
string ,
product_version:
{
Description: Product version. ,
Required: False ,
}
string ,
is_debug:
{
Description: Is debug? ,
Required: False ,
}
boolean ,
language:
{
Description: Module language (locale). ,
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 ,
}
,
}
WebApps_ListProcessThreadsSlot (new)
Description :  Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
processId:
{
Description: PID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
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: ProcessThreadInfo resource specific properties ,
Required: False ,
}
{
identifier:
{
Description: Site extension ID. ,
Format: int32 ,
Required: False ,
}
integer ,
href:
{
Description: HRef URI. ,
Required: False ,
}
string ,
process:
{
Description: Process URI. ,
Required: False ,
}
string ,
start_address:
{
Description: Start address. ,
Required: False ,
}
string ,
current_priority:
{
Description: Current thread priority. ,
Format: int32 ,
Required: False ,
}
integer ,
priority_level:
{
Description: Thread priority level. ,
Required: False ,
}
string ,
base_priority:
{
Description: Base priority. ,
Format: int32 ,
Required: False ,
}
integer ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
total_processor_time:
{
Description: Total processor time. ,
Required: False ,
}
string ,
user_processor_time:
{
Description: User processor time. ,
Required: False ,
}
string ,
state:
{
Description: Thread state. ,
Required: False ,
}
string ,
wait_reason:
{
Description: Wait reason. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_ListPublicCertificatesSlot (new)
Description :  Description for Get public certificates for an app or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot. ,
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: PublicCertificate resource specific properties ,
Required: False ,
}
{
blob:
{
Description: Public Certificate byte array ,
Format: byte ,
Required: False ,
}
string ,
publicCertificateLocation:
{
Description: Public Certificate Location ,
Enum:
{
CurrentUserMy: No description available. ,
LocalMachineMy: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: Certificate Thumbprint ,
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 ,
}
,
}
WebApps_GetPublicCertificateSlot (new)
Description :  Description for Get the named public certificate for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot. ,
Required: True ,
}
string ,
publicCertificateName:
{
Description: Public certificate name. ,
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: PublicCertificate resource specific properties ,
Required: False ,
}
{
blob:
{
Description: Public Certificate byte array ,
Format: byte ,
Required: False ,
}
string ,
publicCertificateLocation:
{
Description: Public Certificate Location ,
Enum:
{
CurrentUserMy: No description available. ,
LocalMachineMy: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: Certificate Thumbprint ,
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 ,
}
,
}
WebApps_CreateOrUpdatePublicCertificateSlot (new)
Description :  Description for Creates a hostname binding for an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
publicCertificateName:
{
Description: Public certificate name. ,
Required: True ,
}
string ,
publicCertificate:
{
Description: Public certificate details. This is the JSON representation of a PublicCertificate object. ,
Required: True ,
}
{
properties:
{
Description: PublicCertificate resource specific properties ,
Required: False ,
}
{
blob:
{
Description: Public Certificate byte array ,
Format: byte ,
Required: False ,
}
string ,
publicCertificateLocation:
{
Description: Public Certificate Location ,
Enum:
{
CurrentUserMy: No description available. ,
LocalMachineMy: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: Certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. ,
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: PublicCertificate resource specific properties ,
Required: False ,
}
{
blob:
{
Description: Public Certificate byte array ,
Format: byte ,
Required: False ,
}
string ,
publicCertificateLocation:
{
Description: Public Certificate Location ,
Enum:
{
CurrentUserMy: No description available. ,
LocalMachineMy: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
thumbprint:
{
Description: Certificate Thumbprint ,
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 ,
}
,
}
WebApps_DeletePublicCertificateSlot (new)
Description :  Description for Deletes a hostname binding for an app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. ,
Required: True ,
}
string ,
publicCertificateName:
{
Description: Public certificate name. ,
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 ,
}
,
}
WebApps_ListPublishingProfileXmlWithSecretsSlot (new)
Description :  Description for Gets the publishing profile for an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
publishingProfileOptions:
{
Description: Specifies publishingProfileOptions for publishing profile. For example, use {"format": "FileZilla3"} to get a FileZilla publishing profile. ,
Required: True ,
}
{
format:
{
Description: Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp ,
Enum:
{
FileZilla3: No description available. ,
WebDeploy: No description available. ,
Ftp: No description available. ,
}
,
Required: False ,
}
enum ,
includeDisasterRecoveryEndpoints:
{
Description: Include the DisasterRecover endpoint if true ,
Required: False ,
}
boolean ,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the publishing profile for the production slot. ,
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: file ,
}

⚐ 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 ,
}
,
}
WebApps_ResetSlotConfigurationSlot (new)
Description :  Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API resets configuration settings for the production slot. ,
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 ,
}
,
}
WebApps_RestartSlot (new)
Description :  Description for Restarts an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will restart the production slot. ,
Required: True ,
}
string ,
softRestart:
{
Description: Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app. ,
Required: False ,
}
boolean ,
synchronous:
{
Description: Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous). ,
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)

{}

⚐ 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 ,
}
,
}
WebApps_RestoreFromBackupBlobSlot (new)
Description :  Description for Restores an app from a backup blob in Azure Storage.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromBackupBlob
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request . ,
Required: True ,
}
{
properties:
{
Description: RestoreRequest resource specific properties ,
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container. ,
Required: True ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup. ,
Required: False ,
}
string ,
overwrite:
{
Description: true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. ,
Required: True ,
}
boolean ,
siteName:
{
Description: Name of an app. ,
Required: False ,
}
string ,
databases:
{
Description: Collection of databases which should be restored. This list has to match the list of databases included in the backup. ,
Required: False ,
}
[
{
databaseType:
{
Description: Database type (e.g. SqlAzure / MySql). ,
Enum:
{
SqlAzure: No description available. ,
MySql: No description available. ,
LocalMySql: No description available. ,
PostgreSql: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Required: False ,
}
string ,
connectionStringName:
{
Description: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. ,
Required: False ,
}
string ,
connectionString:
{
Description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
ignoreConflictingHostNames:
{
Description: Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
ignoreDatabases:
{
Description: Ignore the databases and only restore the site content ,
Required: False ,
}
boolean ,
appServicePlan:
{
Description: Specify app service plan that will own restored site. ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
Snapshot: No description available. ,
CloudFS: No description available. ,
}
,
Required: False ,
}
enum ,
adjustConnectionStrings:
{
Description: true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false. ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring an app to an App Service Environment). ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot. ,
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 (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 ,
}
,
}
WebApps_RestoreFromDeletedAppSlot (new)
Description :  Description for Restores a deleted web app to this web app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromDeletedApp
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
restoreRequest:
{
Description: Deleted web app restore information. ,
Required: True ,
}
{
properties:
{
Description: DeletedAppRestoreRequest resource specific properties ,
Required: False ,
}
{
deletedSiteId:
{
Description: ARM resource ID of the deleted app. Example: /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId} ,
Required: False ,
}
string ,
recoverConfiguration:
{
Description: If true, deleted site configuration, in addition to content, will be restored. ,
Required: False ,
}
boolean ,
snapshotTime:
{
Description: Point in time to restore the deleted app from, formatted as a DateTime string. If unspecified, default value is the time that the app was deleted. ,
Required: False ,
}
string ,
useDRSecondary:
{
Description: If true, the snapshot is retrieved from DRSecondary endpoint. ,
Required: False ,
}
boolean ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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 (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 ,
}
,
}
WebApps_RestoreSnapshotSlot (new)
Description :  Description for Restores a web app from a snapshot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
restoreRequest:
{
Description: Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. ,
Required: True ,
}
{
properties:
{
Description: SnapshotRestoreRequest resource specific properties ,
Required: False ,
}
{
snapshotTime:
{
Description: Point in time in which the app restore should be done, formatted as a DateTime string. ,
Required: False ,
}
string ,
recoverySource:
{
Description: Optional. Specifies the web app that snapshot contents will be retrieved from. If empty, the targeted web app will be used as the source. ,
Required: False ,
}
{
location:
{
Description: Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS ,
Required: False ,
}
string ,
id:
{
Description: ARM resource ID of the source app. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. ,
Required: False ,
}
string ,
}
,
overwrite:
{
Description: If true the restore operation can overwrite source app; otherwise, false. ,
Required: True ,
}
boolean ,
recoverConfiguration:
{
Description: If true, site configuration, in addition to content, will be reverted. ,
Required: False ,
}
boolean ,
ignoreConflictingHostNames:
{
Description: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. ,
Required: False ,
}
boolean ,
useDRSecondary:
{
Description: If true, the snapshot is retrieved from DRSecondary endpoint. ,
Required: False ,
}
boolean ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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 (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 ,
}
,
}
WebApps_ListSiteContainersSlot (new)
Description :  Lists all the site containers of a site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get a list of site containers for the production slot. ,
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: SiteContainer resource specific properties ,
Required: False ,
}
{
image:
{
Description: Image Name ,
Required: True ,
}
string ,
targetPort:
{
Description: Target Port ,
Required: False ,
}
string ,
isMain:
{
Description: true if the container is the main site container; false otherwise. ,
Required: True ,
}
boolean ,
startUpCommand:
{
Description: StartUp Command ,
Required: False ,
}
string ,
authType:
{
Description: Auth Type ,
Enum:
{
Anonymous: No description available. ,
UserCredentials: No description available. ,
SystemIdentity: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userName:
{
Description: User Name ,
Required: False ,
}
string ,
passwordSecret:
{
Description: Password Secret ,
Required: False ,
}
string ,
userManagedIdentityClientId:
{
Description: UserManagedIdentity ClientId ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last Modified Time ,
Format: date-time ,
Required: False ,
}
string ,
volumeMounts:
{
Description: List of volume mounts ,
Required: False ,
}
[
{
volumeSubPath:
{
Description: Sub path in the volume where volume is mounted from. ,
Required: True ,
}
string ,
containerMountPath:
{
Description: Target path on the container where volume is mounted on ,
Required: True ,
}
string ,
data:
{
Description: Config Data to be mounted on the volume ,
Required: False ,
}
string ,
readOnly:
{
Description: Boolean to specify if the mount is read only on the container ,
Required: False ,
}
boolean ,
}
,
]
,
inheritAppSettingsAndConnectionStrings:
{
Description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise. ,
Required: False ,
}
boolean ,
environmentVariables:
{
Description: List of environment variables ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name ,
Required: True ,
}
string ,
value:
{
Description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. ,
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 ,
}
,
}
WebApps_GetSiteContainerSlot (new)
Description :  Gets a site container of a site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot. ,
Required: True ,
}
string ,
containerName:
{
Description: Site Container Name ,
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: SiteContainer resource specific properties ,
Required: False ,
}
{
image:
{
Description: Image Name ,
Required: True ,
}
string ,
targetPort:
{
Description: Target Port ,
Required: False ,
}
string ,
isMain:
{
Description: true if the container is the main site container; false otherwise. ,
Required: True ,
}
boolean ,
startUpCommand:
{
Description: StartUp Command ,
Required: False ,
}
string ,
authType:
{
Description: Auth Type ,
Enum:
{
Anonymous: No description available. ,
UserCredentials: No description available. ,
SystemIdentity: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userName:
{
Description: User Name ,
Required: False ,
}
string ,
passwordSecret:
{
Description: Password Secret ,
Required: False ,
}
string ,
userManagedIdentityClientId:
{
Description: UserManagedIdentity ClientId ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last Modified Time ,
Format: date-time ,
Required: False ,
}
string ,
volumeMounts:
{
Description: List of volume mounts ,
Required: False ,
}
[
{
volumeSubPath:
{
Description: Sub path in the volume where volume is mounted from. ,
Required: True ,
}
string ,
containerMountPath:
{
Description: Target path on the container where volume is mounted on ,
Required: True ,
}
string ,
data:
{
Description: Config Data to be mounted on the volume ,
Required: False ,
}
string ,
readOnly:
{
Description: Boolean to specify if the mount is read only on the container ,
Required: False ,
}
boolean ,
}
,
]
,
inheritAppSettingsAndConnectionStrings:
{
Description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise. ,
Required: False ,
}
boolean ,
environmentVariables:
{
Description: List of environment variables ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name ,
Required: True ,
}
string ,
value:
{
Description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. ,
Required: True ,
}
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 ,
}
,
}
WebApps_CreateOrUpdateSiteContainerSlot (new)
Description :  Creates or Updates a site container for a site, or a deployment slot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will create the container for the production slot. ,
Required: True ,
}
string ,
containerName:
{
Description: Site Container Name ,
Required: True ,
}
string ,
request:
{
Description: Container Entity ,
Required: True ,
}
{
properties:
{
Description: SiteContainer resource specific properties ,
Required: False ,
}
{
image:
{
Description: Image Name ,
Required: True ,
}
string ,
targetPort:
{
Description: Target Port ,
Required: False ,
}
string ,
isMain:
{
Description: true if the container is the main site container; false otherwise. ,
Required: True ,
}
boolean ,
startUpCommand:
{
Description: StartUp Command ,
Required: False ,
}
string ,
authType:
{
Description: Auth Type ,
Enum:
{
Anonymous: No description available. ,
UserCredentials: No description available. ,
SystemIdentity: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userName:
{
Description: User Name ,
Required: False ,
}
string ,
passwordSecret:
{
Description: Password Secret ,
Required: False ,
}
string ,
userManagedIdentityClientId:
{
Description: UserManagedIdentity ClientId ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last Modified Time ,
Format: date-time ,
Required: False ,
}
string ,
volumeMounts:
{
Description: List of volume mounts ,
Required: False ,
}
[
{
volumeSubPath:
{
Description: Sub path in the volume where volume is mounted from. ,
Required: True ,
}
string ,
containerMountPath:
{
Description: Target path on the container where volume is mounted on ,
Required: True ,
}
string ,
data:
{
Description: Config Data to be mounted on the volume ,
Required: False ,
}
string ,
readOnly:
{
Description: Boolean to specify if the mount is read only on the container ,
Required: False ,
}
boolean ,
}
,
]
,
inheritAppSettingsAndConnectionStrings:
{
Description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise. ,
Required: False ,
}
boolean ,
environmentVariables:
{
Description: List of environment variables ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name ,
Required: True ,
}
string ,
value:
{
Description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. ,
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 (201)

{
properties:
{
Description: SiteContainer resource specific properties ,
Required: False ,
}
{
image:
{
Description: Image Name ,
Required: True ,
}
string ,
targetPort:
{
Description: Target Port ,
Required: False ,
}
string ,
isMain:
{
Description: true if the container is the main site container; false otherwise. ,
Required: True ,
}
boolean ,
startUpCommand:
{
Description: StartUp Command ,
Required: False ,
}
string ,
authType:
{
Description: Auth Type ,
Enum:
{
Anonymous: No description available. ,
UserCredentials: No description available. ,
SystemIdentity: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userName:
{
Description: User Name ,
Required: False ,
}
string ,
passwordSecret:
{
Description: Password Secret ,
Required: False ,
}
string ,
userManagedIdentityClientId:
{
Description: UserManagedIdentity ClientId ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last Modified Time ,
Format: date-time ,
Required: False ,
}
string ,
volumeMounts:
{
Description: List of volume mounts ,
Required: False ,
}
[
{
volumeSubPath:
{
Description: Sub path in the volume where volume is mounted from. ,
Required: True ,
}
string ,
containerMountPath:
{
Description: Target path on the container where volume is mounted on ,
Required: True ,
}
string ,
data:
{
Description: Config Data to be mounted on the volume ,
Required: False ,
}
string ,
readOnly:
{
Description: Boolean to specify if the mount is read only on the container ,
Required: False ,
}
boolean ,
}
,
]
,
inheritAppSettingsAndConnectionStrings:
{
Description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise. ,
Required: False ,
}
boolean ,
environmentVariables:
{
Description: List of environment variables ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name ,
Required: True ,
}
string ,
value:
{
Description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SiteContainer resource specific properties ,
Required: False ,
}
{
image:
{
Description: Image Name ,
Required: True ,
}
string ,
targetPort:
{
Description: Target Port ,
Required: False ,
}
string ,
isMain:
{
Description: true if the container is the main site container; false otherwise. ,
Required: True ,
}
boolean ,
startUpCommand:
{
Description: StartUp Command ,
Required: False ,
}
string ,
authType:
{
Description: Auth Type ,
Enum:
{
Anonymous: No description available. ,
UserCredentials: No description available. ,
SystemIdentity: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userName:
{
Description: User Name ,
Required: False ,
}
string ,
passwordSecret:
{
Description: Password Secret ,
Required: False ,
}
string ,
userManagedIdentityClientId:
{
Description: UserManagedIdentity ClientId ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last Modified Time ,
Format: date-time ,
Required: False ,
}
string ,
volumeMounts:
{
Description: List of volume mounts ,
Required: False ,
}
[
{
volumeSubPath:
{
Description: Sub path in the volume where volume is mounted from. ,
Required: True ,
}
string ,
containerMountPath:
{
Description: Target path on the container where volume is mounted on ,
Required: True ,
}
string ,
data:
{
Description: Config Data to be mounted on the volume ,
Required: False ,
}
string ,
readOnly:
{
Description: Boolean to specify if the mount is read only on the container ,
Required: False ,
}
boolean ,
}
,
]
,
inheritAppSettingsAndConnectionStrings:
{
Description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise. ,
Required: False ,
}
boolean ,
environmentVariables:
{
Description: List of environment variables ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name ,
Required: True ,
}
string ,
value:
{
Description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. ,
Required: True ,
}
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 ,
}
,
}
WebApps_DeleteSiteContainerSlot (new)
Description :  Deletes a site container for a site, or a deployment slot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the container for the production slot. ,
Required: True ,
}
string ,
containerName:
{
Description: Site Container Name ,
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 ,
}
,
}
WebApps_ListSiteExtensionsSlot (new)
Description :  Description for Get list of siteextensions for a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API uses the production slot. ,
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: SiteExtensionInfo resource specific properties ,
Required: False ,
}
{
extension_id:
{
Description: Site extension ID. ,
Required: False ,
}
string ,
title:
{
Required: False ,
}
string ,
extension_type:
{
Description: Site extension type. ,
Enum:
{
Gallery: No description available. ,
WebRoot: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description. ,
Required: False ,
}
string ,
version:
{
Description: Version information. ,
Required: False ,
}
string ,
extension_url:
{
Description: Extension URL. ,
Required: False ,
}
string ,
project_url:
{
Description: Project URL. ,
Required: False ,
}
string ,
icon_url:
{
Description: Icon URL. ,
Required: False ,
}
string ,
license_url:
{
Description: License URL. ,
Required: False ,
}
string ,
feed_url:
{
Description: Feed URL. ,
Required: False ,
}
string ,
authors:
{
Description: List of authors. ,
Required: False ,
}
[
string ,
]
,
installer_command_line_params:
{
Description: Installer command line parameters. ,
Required: False ,
}
string ,
published_date_time:
{
Description: Published timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
download_count:
{
Description: Count of downloads. ,
Format: int32 ,
Required: False ,
}
integer ,
local_is_latest_version:
{
Description: true if the local version is the latest version; false otherwise. ,
Required: False ,
}
boolean ,
local_path:
{
Description: Local path. ,
Required: False ,
}
string ,
installed_date_time:
{
Description: Installed timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Required: False ,
}
string ,
comment:
{
Description: Site Extension comment. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetSiteExtensionSlot (new)
Description :  Description for Get site extension information by its ID for a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
siteExtensionId:
{
Description: Site extension name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API uses the production slot. ,
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: SiteExtensionInfo resource specific properties ,
Required: False ,
}
{
extension_id:
{
Description: Site extension ID. ,
Required: False ,
}
string ,
title:
{
Required: False ,
}
string ,
extension_type:
{
Description: Site extension type. ,
Enum:
{
Gallery: No description available. ,
WebRoot: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description. ,
Required: False ,
}
string ,
version:
{
Description: Version information. ,
Required: False ,
}
string ,
extension_url:
{
Description: Extension URL. ,
Required: False ,
}
string ,
project_url:
{
Description: Project URL. ,
Required: False ,
}
string ,
icon_url:
{
Description: Icon URL. ,
Required: False ,
}
string ,
license_url:
{
Description: License URL. ,
Required: False ,
}
string ,
feed_url:
{
Description: Feed URL. ,
Required: False ,
}
string ,
authors:
{
Description: List of authors. ,
Required: False ,
}
[
string ,
]
,
installer_command_line_params:
{
Description: Installer command line parameters. ,
Required: False ,
}
string ,
published_date_time:
{
Description: Published timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
download_count:
{
Description: Count of downloads. ,
Format: int32 ,
Required: False ,
}
integer ,
local_is_latest_version:
{
Description: true if the local version is the latest version; false otherwise. ,
Required: False ,
}
boolean ,
local_path:
{
Description: Local path. ,
Required: False ,
}
string ,
installed_date_time:
{
Description: Installed timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Required: False ,
}
string ,
comment:
{
Description: Site Extension comment. ,
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 ,
}
,
}
WebApps_InstallSiteExtensionSlot (new)
Description :  Description for Install site extension on a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
siteExtensionId:
{
Description: Site extension name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API uses the production slot. ,
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 (201)

{
properties:
{
Description: SiteExtensionInfo resource specific properties ,
Required: False ,
}
{
extension_id:
{
Description: Site extension ID. ,
Required: False ,
}
string ,
title:
{
Required: False ,
}
string ,
extension_type:
{
Description: Site extension type. ,
Enum:
{
Gallery: No description available. ,
WebRoot: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description. ,
Required: False ,
}
string ,
version:
{
Description: Version information. ,
Required: False ,
}
string ,
extension_url:
{
Description: Extension URL. ,
Required: False ,
}
string ,
project_url:
{
Description: Project URL. ,
Required: False ,
}
string ,
icon_url:
{
Description: Icon URL. ,
Required: False ,
}
string ,
license_url:
{
Description: License URL. ,
Required: False ,
}
string ,
feed_url:
{
Description: Feed URL. ,
Required: False ,
}
string ,
authors:
{
Description: List of authors. ,
Required: False ,
}
[
string ,
]
,
installer_command_line_params:
{
Description: Installer command line parameters. ,
Required: False ,
}
string ,
published_date_time:
{
Description: Published timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
download_count:
{
Description: Count of downloads. ,
Format: int32 ,
Required: False ,
}
integer ,
local_is_latest_version:
{
Description: true if the local version is the latest version; false otherwise. ,
Required: False ,
}
boolean ,
local_path:
{
Description: Local path. ,
Required: False ,
}
string ,
installed_date_time:
{
Description: Installed timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Required: False ,
}
string ,
comment:
{
Description: Site Extension comment. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SiteExtensionInfo resource specific properties ,
Required: False ,
}
{
extension_id:
{
Description: Site extension ID. ,
Required: False ,
}
string ,
title:
{
Required: False ,
}
string ,
extension_type:
{
Description: Site extension type. ,
Enum:
{
Gallery: No description available. ,
WebRoot: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description. ,
Required: False ,
}
string ,
version:
{
Description: Version information. ,
Required: False ,
}
string ,
extension_url:
{
Description: Extension URL. ,
Required: False ,
}
string ,
project_url:
{
Description: Project URL. ,
Required: False ,
}
string ,
icon_url:
{
Description: Icon URL. ,
Required: False ,
}
string ,
license_url:
{
Description: License URL. ,
Required: False ,
}
string ,
feed_url:
{
Description: Feed URL. ,
Required: False ,
}
string ,
authors:
{
Description: List of authors. ,
Required: False ,
}
[
string ,
]
,
installer_command_line_params:
{
Description: Installer command line parameters. ,
Required: False ,
}
string ,
published_date_time:
{
Description: Published timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
download_count:
{
Description: Count of downloads. ,
Format: int32 ,
Required: False ,
}
integer ,
local_is_latest_version:
{
Description: true if the local version is the latest version; false otherwise. ,
Required: False ,
}
boolean ,
local_path:
{
Description: Local path. ,
Required: False ,
}
string ,
installed_date_time:
{
Description: Installed timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Required: False ,
}
string ,
comment:
{
Description: Site Extension comment. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{}

⚐ 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 ,
}
,
}
WebApps_DeleteSiteExtensionSlot (new)
Description :  Description for Remove a site extension from a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
siteExtensionId:
{
Description: Site extension name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_ListSlotDifferencesSlot (new)
Description :  Description for Get the difference in configuration settings between two web app slots.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: JSON object that contains the target slot name. See example. ,
Required: True ,
}
{
targetSlot:
{
Description: Destination deployment slot during swap operation. ,
Required: True ,
}
string ,
preserveVnet:
{
Description: true to preserve Virtual Network to the slot during swap; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
slot:
{
Description: Name of the source slot. If a slot is not specified, the production slot is used as the source slot. ,
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: SlotDifference resource specific properties ,
Required: False ,
}
{
level:
{
Description: Level of the difference: Information, Warning or Error. ,
Required: False ,
}
string ,
settingType:
{
Description: The type of the setting: General, AppSetting or ConnectionString. ,
Required: False ,
}
string ,
diffRule:
{
Description: Rule that describes how to process the setting difference during a slot swap. ,
Required: False ,
}
string ,
settingName:
{
Description: Name of the setting. ,
Required: False ,
}
string ,
valueInCurrentSlot:
{
Description: Value of the setting in the current slot. ,
Required: False ,
}
string ,
valueInTargetSlot:
{
Description: Value of the setting in the target slot. ,
Required: False ,
}
string ,
description:
{
Description: Description of the setting difference. ,
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 ,
}
,
}
WebApps_SwapSlotSlot (new)
Description :  Description for Swaps two deployment slots of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: JSON object that contains the target slot name. See example. ,
Required: True ,
}
{
targetSlot:
{
Description: Destination deployment slot during swap operation. ,
Required: True ,
}
string ,
preserveVnet:
{
Description: true to preserve Virtual Network to the slot during swap; otherwise, false. ,
Required: True ,
}
boolean ,
}
,
slot:
{
Description: Name of the source slot. If a slot is not specified, the production slot is used as the source slot. ,
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 (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 ,
}
,
}
WebApps_ListSnapshotsSlot (new)
Description :  Description for Returns all Snapshots to the user.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Website Name. ,
Required: True ,
}
string ,
slot:
{
Description: Website Slot. ,
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: Snapshot resource specific properties ,
Required: False ,
}
{
time:
{
Description: The time the snapshot was taken. ,
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 ,
}
,
}
WebApps_ListSnapshotsFromDRSecondarySlot (new)
Description :  Description for Returns all Snapshots to the user from DRSecondary endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Website Name. ,
Required: True ,
}
string ,
slot:
{
Description: Website Slot. ,
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: Snapshot resource specific properties ,
Required: False ,
}
{
time:
{
Description: The time the snapshot was taken. ,
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 ,
}
,
}
WebApps_GetSourceControlSlot (new)
Description :  Description for Gets the source control configuration of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot. ,
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: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateSourceControlSlot (new)
Description :  Description for Updates the source control configuration of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: JSON representation of a SiteSourceControl object. See example. ,
Required: True ,
}
{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot. ,
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: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteSourceControlSlot (new)
Description :  Description for Deletes the source control configuration of an app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the source control configuration for the production slot. ,
Required: True ,
}
string ,
additionalFlags:
{
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)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateSourceControlSlot (new)
Description :  Description for Updates the source control configuration of an app.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: JSON representation of a SiteSourceControl object. See example. ,
Required: True ,
}
{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot. ,
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: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_StartSlot (new)
Description :  Description for Starts an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will start the production slot. ,
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 ,
}
,
}
WebApps_StartNetworkTraceSlot (new)
Description :  Description for Start capturing network packets for the site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/startNetworkTrace
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
durationInSeconds:
{
Description: The duration to keep capturing in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
maxFrameLength:
{
Description: The maximum frame length in bytes (Optional). ,
Format: int32 ,
Required: False ,
}
integer ,
sasUrl:
{
Description: The Blob URL to store capture file. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_StopSlot (new)
Description :  Description for Stops an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will stop the production slot. ,
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 ,
}
,
}
WebApps_StopNetworkTraceSlot (new)
Description :  Description for Stop ongoing capturing network packets for the site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stopNetworkTrace
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for this web app. ,
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 ,
}
,
}
WebApps_SyncRepositorySlot (new)
Description :  Description for Sync web app repository.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
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 ,
}
,
}
WebApps_SyncFunctionTriggersSlot (new)
Description :  Description for Syncs function trigger metadata to the management database
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_ListTriggeredWebJobsSlot (new)
Description :  Description for List triggered web jobs for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. ,
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: TriggeredWebJob resource specific properties ,
Required: False ,
}
{
latest_run:
{
Description: Latest job run information. ,
Required: False ,
}
{
web_job_id:
{
Description: Job ID. ,
Required: False ,
}
string ,
web_job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Job duration. ,
Required: False ,
}
string ,
output_url:
{
Description: Output URL. ,
Required: False ,
}
string ,
error_url:
{
Description: Error URL. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
trigger:
{
Description: Job trigger. ,
Required: False ,
}
string ,
}
,
history_url:
{
Description: History URL. ,
Required: False ,
}
string ,
scheduler_logs_url:
{
Description: Scheduler Logs URL. ,
Required: False ,
}
string ,
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
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 ,
settings:
{
Description: Job settings. ,
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 ,
}
,
}
WebApps_GetTriggeredWebJobSlot (new)
Description :  Description for Gets a triggered web job by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API uses the production slot. ,
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: TriggeredWebJob resource specific properties ,
Required: False ,
}
{
latest_run:
{
Description: Latest job run information. ,
Required: False ,
}
{
web_job_id:
{
Description: Job ID. ,
Required: False ,
}
string ,
web_job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Job duration. ,
Required: False ,
}
string ,
output_url:
{
Description: Output URL. ,
Required: False ,
}
string ,
error_url:
{
Description: Error URL. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
trigger:
{
Description: Job trigger. ,
Required: False ,
}
string ,
}
,
history_url:
{
Description: History URL. ,
Required: False ,
}
string ,
scheduler_logs_url:
{
Description: Scheduler Logs URL. ,
Required: False ,
}
string ,
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
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 ,
settings:
{
Description: Job settings. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteTriggeredWebJobSlot (new)
Description :  Description for Delete a triggered web job by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API deletes web job for the production slot. ,
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 ,
}
,
}
WebApps_ListTriggeredWebJobHistorySlot (new)
Description :  Description for List a triggered web job's history for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API uses the production slot. ,
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: TriggeredJobHistory resource specific properties ,
Required: False ,
}
{
runs:
{
Description: List of triggered web job runs. ,
Required: False ,
}
[
{
web_job_id:
{
Description: Job ID. ,
Required: False ,
}
string ,
web_job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Job duration. ,
Required: False ,
}
string ,
output_url:
{
Description: Output URL. ,
Required: False ,
}
string ,
error_url:
{
Description: Error URL. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
trigger:
{
Description: Job trigger. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetTriggeredWebJobHistorySlot (new)
Description :  Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
Required: True ,
}
string ,
id:
{
Description: History ID. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API uses the production slot. ,
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: TriggeredJobHistory resource specific properties ,
Required: False ,
}
{
runs:
{
Description: List of triggered web job runs. ,
Required: False ,
}
[
{
web_job_id:
{
Description: Job ID. ,
Required: False ,
}
string ,
web_job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Job duration. ,
Required: False ,
}
string ,
output_url:
{
Description: Output URL. ,
Required: False ,
}
string ,
error_url:
{
Description: Error URL. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
trigger:
{
Description: Job trigger. ,
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 ,
}
,
}
WebApps_RunTriggeredWebJobSlot (new)
Description :  Description for Run a triggered web job for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API uses the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_ListUsagesSlot (new)
Description :  Description for Gets the quota usage information of an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get quota information of the production slot. ,
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 information specified in the filter (using OData syntax). For 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 ,
}
,
}
WebApps_ListVnetConnectionsSlot (new)
Description :  Description for Gets the virtual networks the app (or deployment slot) is connected to.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get virtual network connections for the production slot. ,
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 ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_GetVnetConnectionSlot (new)
Description :  Description for Gets a virtual network the app (or deployment slot) is connected to by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the virtual network. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot. ,
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 ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateVnetConnectionSlot (new)
Description :  Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of an existing Virtual Network. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Properties of the Virtual Network connection. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
Required: False ,
}
boolean ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot. ,
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 ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteVnetConnectionSlot (new)
Description :  Description for Deletes a connection from an app (or deployment slot to a named virtual network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the virtual network. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateVnetConnectionSlot (new)
Description :  Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of an existing Virtual Network. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Properties of the Virtual Network connection. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
Required: False ,
}
boolean ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot. ,
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 ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_GetVnetConnectionGatewaySlot (new)
Description :  Description for Gets an app's Virtual Network gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Name of the gateway. Currently, the only supported string is "primary". ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateVnetConnectionGatewaySlot (new)
Description :  Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Name of the gateway. Currently, the only supported string is "primary". ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties to update this gateway with. ,
Required: True ,
}
{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateVnetConnectionGatewaySlot (new)
Description :  Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of the Virtual Network. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Name of the gateway. Currently, the only supported string is "primary". ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties to update this gateway with. ,
Required: True ,
}
{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}
,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListWebJobsSlot (new)
Description :  Description for List webjobs for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
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: WebJob resource specific properties ,
Required: False ,
}
{
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
settings:
{
Description: Job settings. ,
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 ,
}
,
}
WebApps_GetWebJobSlot (new)
Description :  Description for Get webjob information for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of the web job. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. ,
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: WebJob resource specific properties ,
Required: False ,
}
{
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
settings:
{
Description: Job settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_ListSlotDifferencesFromProduction (new)
Description :  Description for Get the difference in configuration settings between two web app slots.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: JSON object that contains the target slot name. See example. ,
Required: True ,
}
{
targetSlot:
{
Description: Destination deployment slot during swap operation. ,
Required: True ,
}
string ,
preserveVnet:
{
Description: true to preserve Virtual Network to the slot during swap; otherwise, false. ,
Required: True ,
}
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: SlotDifference resource specific properties ,
Required: False ,
}
{
level:
{
Description: Level of the difference: Information, Warning or Error. ,
Required: False ,
}
string ,
settingType:
{
Description: The type of the setting: General, AppSetting or ConnectionString. ,
Required: False ,
}
string ,
diffRule:
{
Description: Rule that describes how to process the setting difference during a slot swap. ,
Required: False ,
}
string ,
settingName:
{
Description: Name of the setting. ,
Required: False ,
}
string ,
valueInCurrentSlot:
{
Description: Value of the setting in the current slot. ,
Required: False ,
}
string ,
valueInTargetSlot:
{
Description: Value of the setting in the target slot. ,
Required: False ,
}
string ,
description:
{
Description: Description of the setting difference. ,
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 ,
}
,
}
WebApps_SwapSlotWithProduction (new)
Description :  Description for Swaps two deployment slots of an app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: JSON object that contains the target slot name. See example. ,
Required: True ,
}
{
targetSlot:
{
Description: Destination deployment slot during swap operation. ,
Required: True ,
}
string ,
preserveVnet:
{
Description: true to preserve Virtual Network to the slot during swap; otherwise, false. ,
Required: True ,
}
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)

{}

⚐ 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 ,
}
,
}
WebApps_ListSnapshots (new)
Description :  Description for Returns all Snapshots to the user.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Website Name. ,
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: Snapshot resource specific properties ,
Required: False ,
}
{
time:
{
Description: The time the snapshot was taken. ,
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 ,
}
,
}
WebApps_ListSnapshotsFromDRSecondary (new)
Description :  Description for Returns all Snapshots to the user from DRSecondary endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Website Name. ,
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: Snapshot resource specific properties ,
Required: False ,
}
{
time:
{
Description: The time the snapshot was taken. ,
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 ,
}
,
}
WebApps_GetSourceControl (new)
Description :  Description for Gets the source control configuration of an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateSourceControl (new)
Description :  Description for Updates the source control configuration of an app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: JSON representation of a SiteSourceControl object. See example. ,
Required: True ,
}
{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
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)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteSourceControl (new)
Description :  Description for Deletes the source control configuration of an app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
additionalFlags:
{
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)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateSourceControl (new)
Description :  Description for Updates the source control configuration of an app.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: JSON representation of a SiteSourceControl object. See example. ,
Required: True ,
}
{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
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)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: SiteSourceControl resource specific properties ,
Required: False ,
}
{
repoUrl:
{
Description: Repository or source control URL. ,
Required: False ,
}
string ,
branch:
{
Description: Name of branch to use for deployment. ,
Required: False ,
}
string ,
isManualIntegration:
{
Description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). ,
Required: False ,
}
boolean ,
isGitHubAction:
{
Description: true if this is deployed via GitHub action. ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: true to enable deployment rollback; otherwise, false. ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: true for a Mercurial repository; false for a Git repository. ,
Required: False ,
}
boolean ,
gitHubActionConfiguration:
{
Description: If GitHub Action is selected, than the associated configuration. ,
Required: False ,
}
{
codeConfiguration:
{
Description: GitHub Action code configuration. ,
Required: False ,
}
{
runtimeStack:
{
Description: Runtime stack is used to determine the workflow file content for code base apps. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version is used to determine what build version to set in the workflow file. ,
Required: False ,
}
string ,
}
,
containerConfiguration:
{
Description: GitHub Action container configuration. ,
Required: False ,
}
{
serverUrl:
{
Description: The server URL for the container registry where the build will be hosted. ,
Required: False ,
}
string ,
imageName:
{
Description: The image name for the build. ,
Required: False ,
}
string ,
username:
{
Description: The username used to upload the image to the container registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to upload the image to the container registry. ,
Required: False ,
}
string ,
}
,
isLinux:
{
Description: This will help determine the workflow configuration to select. ,
Required: False ,
}
boolean ,
generateWorkflowFile:
{
Description: Workflow option to determine whether the workflow file should be generated and written to the repository. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_Start (new)
Description :  Description for Starts an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 ,
}
,
}
WebApps_StartNetworkTrace (new)
Description :  Description for Start capturing network packets for the site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/startNetworkTrace
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
Required: True ,
}
string ,
durationInSeconds:
{
Description: The duration to keep capturing in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFrameLength:
{
Description: The maximum frame length in bytes (Optional). ,
Format: int32 ,
Required: False ,
}
integer ,
sasUrl:
{
Description: The Blob URL to store capture file. ,
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)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
path:
{
Description: Local file path for the captured network trace file. ,
Required: False ,
}
string ,
status:
{
Description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). ,
Required: False ,
}
string ,
message:
{
Description: Detailed message of a network trace operation, e.g. error message in case of failure. ,
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 ,
}
,
}
WebApps_Stop (new)
Description :  Description for Stops an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 ,
}
,
}
WebApps_StopNetworkTrace (new)
Description :  Description for Stop ongoing capturing network packets for the site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stopNetworkTrace
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app. ,
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 ,
}
,
}
WebApps_SyncRepository (new)
Description :  Description for Sync web app repository.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of web app. ,
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 ,
}
,
}
WebApps_SyncFunctionTriggers (new)
Description :  Description for Syncs function trigger metadata to the management database
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
WebApps_ListTriggeredWebJobs (new)
Description :  Description for List triggered web jobs for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
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: TriggeredWebJob resource specific properties ,
Required: False ,
}
{
latest_run:
{
Description: Latest job run information. ,
Required: False ,
}
{
web_job_id:
{
Description: Job ID. ,
Required: False ,
}
string ,
web_job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Job duration. ,
Required: False ,
}
string ,
output_url:
{
Description: Output URL. ,
Required: False ,
}
string ,
error_url:
{
Description: Error URL. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
trigger:
{
Description: Job trigger. ,
Required: False ,
}
string ,
}
,
history_url:
{
Description: History URL. ,
Required: False ,
}
string ,
scheduler_logs_url:
{
Description: Scheduler Logs URL. ,
Required: False ,
}
string ,
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
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 ,
settings:
{
Description: Job settings. ,
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 ,
}
,
}
WebApps_GetTriggeredWebJob (new)
Description :  Description for Gets a triggered web job by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
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: TriggeredWebJob resource specific properties ,
Required: False ,
}
{
latest_run:
{
Description: Latest job run information. ,
Required: False ,
}
{
web_job_id:
{
Description: Job ID. ,
Required: False ,
}
string ,
web_job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Job duration. ,
Required: False ,
}
string ,
output_url:
{
Description: Output URL. ,
Required: False ,
}
string ,
error_url:
{
Description: Error URL. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
trigger:
{
Description: Job trigger. ,
Required: False ,
}
string ,
}
,
history_url:
{
Description: History URL. ,
Required: False ,
}
string ,
scheduler_logs_url:
{
Description: Scheduler Logs URL. ,
Required: False ,
}
string ,
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
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 ,
settings:
{
Description: Job settings. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_DeleteTriggeredWebJob (new)
Description :  Description for Delete a triggered web job by its ID for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
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 ,
}
,
}
WebApps_ListTriggeredWebJobHistory (new)
Description :  Description for List a triggered web job's history for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
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: TriggeredJobHistory resource specific properties ,
Required: False ,
}
{
runs:
{
Description: List of triggered web job runs. ,
Required: False ,
}
[
{
web_job_id:
{
Description: Job ID. ,
Required: False ,
}
string ,
web_job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Job duration. ,
Required: False ,
}
string ,
output_url:
{
Description: Output URL. ,
Required: False ,
}
string ,
error_url:
{
Description: Error URL. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
trigger:
{
Description: Job trigger. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
WebApps_GetTriggeredWebJobHistory (new)
Description :  Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of Web Job. ,
Required: True ,
}
string ,
id:
{
Description: History ID. ,
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: TriggeredJobHistory resource specific properties ,
Required: False ,
}
{
runs:
{
Description: List of triggered web job runs. ,
Required: False ,
}
[
{
web_job_id:
{
Description: Job ID. ,
Required: False ,
}
string ,
web_job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
start_time:
{
Description: Start time. ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: End time. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Job duration. ,
Required: False ,
}
string ,
output_url:
{
Description: Output URL. ,
Required: False ,
}
string ,
error_url:
{
Description: Error URL. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
job_name:
{
Description: Job name. ,
Required: False ,
}
string ,
trigger:
{
Description: Job trigger. ,
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 ,
}
,
}
WebApps_RunTriggeredWebJob (new)
Description :  Description for Run a triggered web job for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
}
WebApps_ListUsages (new)
Description :  Description for Gets the quota usage information of an app (or deployment slot, if specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 information specified in the filter (using OData syntax). For 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 ,
}
,
}
WebApps_ListVnetConnections (new)
Description :  Description for Gets the virtual networks the app (or deployment slot) is connected to.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
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 ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_GetVnetConnection (new)
Description :  Description for Gets a virtual network the app (or deployment slot) is connected to by name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateVnetConnection (new)
Description :  Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of an existing Virtual Network. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Properties of the Virtual Network connection. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
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)

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

⚐ 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 ,
}
,
}
WebApps_DeleteVnetConnection (new)
Description :  Description for Deletes a connection from an app (or deployment slot to a named virtual network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
WebApps_UpdateVnetConnection (new)
Description :  Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the app. ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of an existing Virtual Network. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: Properties of the Virtual Network connection. See example. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
vnetResourceId:
{
Description: The Virtual Network's resource ID. ,
Required: False ,
}
string ,
certThumbprint:
{
Description: The client certificate thumbprint. ,
Required: False ,
}
string ,
certBlob:
{
Description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. ,
Required: False ,
}
string ,
routes:
{
Description: The routes that this Virtual Network connection uses. ,
Required: False ,
}
[
{
properties:
{
Description: VnetRoute resource specific properties ,
Required: False ,
}
{
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. ,
Enum:
{
DEFAULT: No description available. ,
INHERITED: No description available. ,
STATIC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
resyncRequired:
{
Description: true if a resync is required; otherwise, false. ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
isSwift:
{
Description: Flag that is used to denote if this is VNET injection ,
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)

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

⚐ 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 ,
}
,
}
WebApps_GetVnetConnectionGateway (new)
Description :  Description for Gets an app's Virtual Network gateway.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_CreateOrUpdateVnetConnectionGateway (new)
Description :  Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_UpdateVnetConnectionGateway (new)
Description :  Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: VnetGateway resource specific properties ,
Required: False ,
}
{
vnetName:
{
Description: The Virtual Network name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the VPN package can be downloaded. ,
Required: True ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListWebJobs (new)
Description :  Description for List webjobs for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
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: WebJob resource specific properties ,
Required: False ,
}
{
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
settings:
{
Description: Job settings. ,
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 ,
}
,
}
WebApps_GetWebJob (new)
Description :  Description for Get webjob information for an app, or a deployment slot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
webJobName:
{
Description: Name of the web job. ,
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: WebJob resource specific properties ,
Required: False ,
}
{
run_command:
{
Description: Run command. ,
Required: False ,
}
string ,
url:
{
Description: Job URL. ,
Required: False ,
}
string ,
extra_info_url:
{
Description: Extra Info URL. ,
Required: False ,
}
string ,
web_job_type:
{
Description: Job type. ,
Enum:
{
Continuous: No description available. ,
Triggered: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error information. ,
Required: False ,
}
string ,
using_sdk:
{
Description: Using SDK? ,
Required: False ,
}
boolean ,
settings:
{
Description: Job settings. ,
Required: False ,
}
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 ,
}
,
}
WebApps_DeployWorkflowArtifacts (new)
Description :  Description for Creates the artifacts for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployWorkflowArtifacts
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
workflowArtifacts:
{
Description: Application settings and files of the workflow. ,
Required: False ,
}
{
appSettings:
{
Description: Application settings of the workflow. ,
Required: False ,
}
object ,
files:
{
Description: Files of the app. ,
Required: False ,
}
object ,
filesToDelete:
{
Description: Files of the app to delete. ,
Required: False ,
}
[
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 ,
}
,
}
WebApps_DeployWorkflowArtifactsSlot (new)
Description :  Description for Creates the artifacts for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployWorkflowArtifacts
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
slot:
{
Description: Name of the deployment slot. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
workflowArtifacts:
{
Description: Application settings and files of the workflow. ,
Required: False ,
}
{
appSettings:
{
Description: Application settings of the workflow. ,
Required: False ,
}
object ,
files:
{
Description: Files of the app. ,
Required: False ,
}
object ,
filesToDelete:
{
Description: Files of the app to delete. ,
Required: False ,
}
[
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 ,
}
,
}
WebApps_ListInstanceWorkflowsSlot (new)
Description :  List the workflows for a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. ,
Required: False ,
}
string ,
location:
{
Description: The resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Additional workflow properties. ,
Required: False ,
}
{
files:
{
Description: Gets or sets the files. ,
Required: False ,
}
object ,
flowState:
{
Description: Gets or sets the state of the workflow. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
health:
{
Description: Gets or sets workflow health. ,
Required: False ,
}
{
state:
{
Description: Gets or sets the workflow health state. ,
Enum:
{
NotSpecified: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Gets or sets the workflow error. ,
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 ,
}
,
}
,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_GetInstanceWorkflowSlot (new)
Description :  Get workflow information by its ID for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. ,
Required: False ,
}
string ,
location:
{
Description: The resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Additional workflow properties. ,
Required: False ,
}
{
files:
{
Description: Gets or sets the files. ,
Required: False ,
}
object ,
flowState:
{
Description: Gets or sets the state of the workflow. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
health:
{
Description: Gets or sets workflow health. ,
Required: False ,
}
{
state:
{
Description: Gets or sets the workflow health state. ,
Enum:
{
NotSpecified: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Gets or sets the workflow error. ,
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListWorkflowsConnectionsSlot (new)
Description :  Lists logic app's connections for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. ,
Required: False ,
}
string ,
location:
{
Description: The resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Additional workflow properties. ,
Required: False ,
}
{
files:
{
Description: Gets or sets the files. ,
Required: False ,
}
object ,
flowState:
{
Description: Gets or sets the state of the workflow. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
health:
{
Description: Gets or sets workflow health. ,
Required: False ,
}
{
state:
{
Description: Gets or sets the workflow health state. ,
Enum:
{
NotSpecified: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Gets or sets the workflow error. ,
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListWorkflows (new)
Description :  List the workflows for a web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. ,
Required: False ,
}
string ,
location:
{
Description: The resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Additional workflow properties. ,
Required: False ,
}
{
files:
{
Description: Gets or sets the files. ,
Required: False ,
}
object ,
flowState:
{
Description: Gets or sets the state of the workflow. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
health:
{
Description: Gets or sets workflow health. ,
Required: False ,
}
{
state:
{
Description: Gets or sets the workflow health state. ,
Enum:
{
NotSpecified: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Gets or sets the workflow error. ,
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 ,
}
,
}
,
}
,
}
,
]
,
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 ,
}
,
}
WebApps_GetWorkflow (new)
Description :  Get workflow information by its ID for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. ,
Required: False ,
}
string ,
location:
{
Description: The resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Additional workflow properties. ,
Required: False ,
}
{
files:
{
Description: Gets or sets the files. ,
Required: False ,
}
object ,
flowState:
{
Description: Gets or sets the state of the workflow. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
health:
{
Description: Gets or sets workflow health. ,
Required: False ,
}
{
state:
{
Description: Gets or sets the workflow health state. ,
Enum:
{
NotSpecified: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Gets or sets the workflow error. ,
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
WebApps_ListWorkflowsConnections (new)
Description :  Lists logic app's connections for web site, or a deployment slot.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
kind:
{
Description: The resource kind. ,
Required: False ,
}
string ,
location:
{
Description: The resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Additional workflow properties. ,
Required: False ,
}
{
files:
{
Description: Gets or sets the files. ,
Required: False ,
}
object ,
flowState:
{
Description: Gets or sets the state of the workflow. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
health:
{
Description: Gets or sets workflow health. ,
Required: False ,
}
{
state:
{
Description: Gets or sets the workflow health state. ,
Enum:
{
NotSpecified: No description available. ,
Healthy: No description available. ,
Unhealthy: No description available. ,
Unknown: No description available. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Gets or sets the workflow error. ,
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
Workflows_RegenerateAccessKey (new)
Description :  Regenerates the callback URL access key for request triggers.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/regenerateAccessKey
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
keyType:
{
Description: The access key type. ,
Required: True ,
}
{
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRuns_List (new)
Description :  Gets a list of workflow runs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow runs. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow run properties. ,
Required: False ,
}
{
waitEndTime:
{
Description: Gets the wait end time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
correlationId:
{
Description: Gets the correlation id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
workflow:
{
Description: Gets the reference to workflow version. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: Gets the fired trigger. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
response:
{
Description: Gets the response of the flow run. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
}
,
name:
{
Description: Gets the workflow run name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRuns_Get (new)
Description :  Gets a workflow run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run properties. ,
Required: False ,
}
{
waitEndTime:
{
Description: Gets the wait end time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
correlationId:
{
Description: Gets the correlation id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
workflow:
{
Description: Gets the reference to workflow version. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: Gets the fired trigger. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
response:
{
Description: Gets the response of the flow run. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
}
,
name:
{
Description: Gets the workflow run name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActions_List (new)
Description :  Gets a list of workflow run actions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. Options for filters include: Status. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow run actions. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow run action properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The correlation properties. ,
Required: False ,
}
{
actionTrackingId:
{
Description: The action tracking identifier. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to inputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to outputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
retryHistory:
{
Description: Gets the retry histories. ,
Required: False ,
}
[
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: Gets the status code. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Gets the service request Id. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error response. ,
Required: False ,
}
{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
name:
{
Description: Gets the workflow run action name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run action type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActions_Get (new)
Description :  Gets a workflow run action.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run action properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The correlation properties. ,
Required: False ,
}
{
actionTrackingId:
{
Description: The action tracking identifier. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to inputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to outputs. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
retryHistory:
{
Description: Gets the retry histories. ,
Required: False ,
}
[
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: Gets the status code. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Gets the service request Id. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error response. ,
Required: False ,
}
{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
name:
{
Description: Gets the workflow run action name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run action type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActions_ListExpressionTraces (new)
Description :  Lists a workflow run expression trace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
string ,
inputs:
{
Required: False ,
}
[
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitions_List (new)
Description :  Get all of a workflow run action repetitions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitions_Get (new)
Description :  Get a workflow run action repetition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitions_ListExpressionTraces (new)
Description :  Lists a workflow run expression trace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
string ,
inputs:
{
Required: False ,
}
[
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitionsRequestHistories_List (new)
Description :  List a workflow run repetition request history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow request histories. ,
Required: False ,
}
[
{
properties:
{
Description: The request history properties. ,
Required: False ,
}
{
startTime:
{
Description: The time the request started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the request ended. ,
Format: date-time ,
Required: False ,
}
string ,
request:
{
Description: The request. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the request. ,
Required: False ,
}
object ,
uri:
{
Description: The destination for the request. ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method used for the request. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the response. ,
Required: False ,
}
object ,
statusCode:
{
Description: The status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
bodyLink:
{
Description: Details on the location of the body content. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitionsRequestHistories_Get (new)
Description :  Gets a workflow run repetition request history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
requestHistoryName:
{
Description: The request history name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The request history properties. ,
Required: False ,
}
{
startTime:
{
Description: The time the request started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the request ended. ,
Format: date-time ,
Required: False ,
}
string ,
request:
{
Description: The request. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the request. ,
Required: False ,
}
object ,
uri:
{
Description: The destination for the request. ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method used for the request. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the response. ,
Required: False ,
}
object ,
statusCode:
{
Description: The status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
bodyLink:
{
Description: Details on the location of the body content. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionScopeRepetitions_List (new)
Description :  List the workflow run action scoped repetitions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionScopeRepetitions_Get (new)
Description :  Get a workflow run action scoped repetition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions/{repetitionName}
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRuns_Cancel (new)
Description :  Cancels a workflow run.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_List (new)
Description :  Gets a list of workflow triggers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow triggers. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow trigger properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
lastExecutionTime:
{
Description: Gets the last execution time. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the next execution time. ,
Format: date-time ,
Required: False ,
}
string ,
recurrence:
{
Description: Gets the workflow trigger recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
workflow:
{
Description: Gets the reference to workflow. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_Get (new)
Description :  Gets a workflow trigger.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow trigger properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
lastExecutionTime:
{
Description: Gets the last execution time. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the next execution time. ,
Format: date-time ,
Required: False ,
}
string ,
recurrence:
{
Description: Gets the workflow trigger recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
workflow:
{
Description: Gets the reference to workflow. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggerHistories_List (new)
Description :  Gets a list of workflow trigger histories.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow trigger histories. ,
Required: False ,
}
[
{
properties:
{
Description: Gets the workflow trigger history properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
scheduledTime:
{
Description: The scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to input parameters. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to output parameters. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
fired:
{
Description: The value indicating whether trigger was fired. ,
Required: False ,
}
boolean ,
run:
{
Description: Gets the reference to workflow run. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger history name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger history type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggerHistories_Get (new)
Description :  Gets a workflow trigger history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
historyName:
{
Description: The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets the workflow trigger history properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
scheduledTime:
{
Description: The scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to input parameters. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to output parameters. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
fired:
{
Description: The value indicating whether trigger was fired. ,
Required: False ,
}
boolean ,
run:
{
Description: Gets the reference to workflow run. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger history name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger history type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggerHistories_Resubmit (new)
Description :  Resubmits a workflow run based on the trigger history.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}/resubmit
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
historyName:
{
Description: The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_ListCallbackUrl (new)
Description :  Get the callback URL for a workflow trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_Run (new)
Description :  Runs a workflow trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/run
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_GetSchemaJson (new)
Description :  Get the trigger schema as JSON.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/schemas/json
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
title:
{
Description: The JSON title. ,
Required: False ,
}
string ,
content:
{
Description: The JSON content. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Validate (new)
Description :  Validates the workflow definition.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/validate
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
validate:
{
Description: The workflow. ,
Required: True ,
}
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
kind:
{
Description: The workflow kind. ,
Enum:
{
Stateful: No description available. ,
Stateless: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowVersions_List (new)
Description :  Gets a list of workflow versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow versions. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow version properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowVersions_Get (new)
Description :  Gets a workflow version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions/{versionId}
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Site name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
versionId:
{
Description: The workflow versionId. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow version properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}