Microsoft.CertificateRegistration (stable:2015-08-01)

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

AppServiceCertificateOrders_List (new)
Description :  List all certificate orders in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/certificateOrders
{
subscriptionId:
{
Description: Your Azure subscription ID. This is 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: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceCertificateOrders_ValidatePurchaseInformation (new)
Description :  Validate information for a certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation
{
appServiceCertificateOrder:
{
Description: Information for a certificate order. ,
Required: True ,
}
{
properties:
{
Description: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
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)

{}
AppServiceCertificateOrders_ListByResourceGroup (new)
Description :  Get certificate orders in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders
{
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: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceCertificateOrders_Get (new)
Description :  Get a certificate order.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_CreateOrUpdate (new)
Description :  Create or update a certificate purchase order.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
certificateDistinguishedName:
{
Description: Distinguished name to use for the certificate order. ,
Required: True ,
}
{
properties:
{
Description: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
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: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_Delete (new)
Description :  Delete an existing certificate order.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is 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)

{}
AppServiceCertificateOrders_Update (new)
Description :  Create or update a certificate purchase order.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
certificateDistinguishedName:
{
Description: Distinguished name to use for the certificate order. ,
Required: True ,
}
{
properties:
{
Description: AppServiceCertificateOrderPatchResource resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
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: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_ListCertificates (new)
Description :  List all certificates associated with a certificate order.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is 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 ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceCertificateOrders_GetCertificate (new)
Description :  Get the certificate associated with a certificate order.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
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: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
AppServiceCertificateOrders_CreateOrUpdateCertificate (new)
Description :  Creates or updates a certificate and associates with key vault secret.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
keyVaultCertificate:
{
Description: Key vault certificate resource Id. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-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 ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
AppServiceCertificateOrders_DeleteCertificate (new)
Description :  Delete the certificate associated with a certificate order.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
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)

{}
AppServiceCertificateOrders_UpdateCertificate (new)
Description :  Creates or updates a certificate and associates with key vault secret.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
keyVaultCertificate:
{
Description: Key vault certificate resource Id. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-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 ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
AppServiceCertificateOrders_Reissue (new)
Description :  Reissue an existing certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/reissue
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
reissueCertificateOrderRequest:
{
Description: Parameters for the reissue. ,
Required: True ,
}
{
properties:
{
Description: ReissueCertificateOrderRequest resource specific properties ,
Required: False ,
}
{
keySize:
{
Description: Certificate Key Size. ,
Format: int32 ,
Required: False ,
}
integer ,
delayExistingRevokeInHours:
{
Description: Delay in hours to revoke existing certificate after the new certificate is issued. ,
Format: int32 ,
Required: False ,
}
integer ,
csr:
{
Description: Csr to be used for re-key operation. ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: Should we change the ASC type (from managed private key to external private key and vice versa). ,
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)

{}
AppServiceCertificateOrders_Renew (new)
Description :  Renew an existing certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/renew
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
renewCertificateOrderRequest:
{
Description: Renew parameters ,
Required: True ,
}
{
properties:
{
Description: RenewCertificateOrderRequest resource specific properties ,
Required: False ,
}
{
keySize:
{
Description: Certificate Key Size. ,
Format: int32 ,
Required: False ,
}
integer ,
csr:
{
Description: Csr to be used for re-key operation. ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: Should we change the ASC type (from managed private key to external private key and vice versa). ,
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)

{}
AppServiceCertificateOrders_ResendEmail (new)
Description :  Resend certificate email.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/resendEmail
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This 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)

{}
AppServiceCertificateOrders_ResendRequestEmails (new)
Description :  Verify domain ownership for this certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/resendRequestEmails
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
nameIdentifier:
{
Description: Email address ,
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 (204)

{}
AppServiceCertificateOrders_RetrieveSiteSeal (new)
Description :  Verify domain ownership for this certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/retrieveSiteSeal
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
siteSealRequest:
{
Description: Site seal request. ,
Required: True ,
}
{
lightTheme:
{
Description: If true use the light color theme for site seal; otherwise, use the default color theme. ,
Required: False ,
}
boolean ,
locale:
{
Description: Locale of site seal. ,
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)

{
html:
{
Description: HTML snippet ,
Required: True ,
}
string ,
}
AppServiceCertificateOrders_VerifyDomainOwnership (new)
Description :  Verify domain ownership for this certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/verifyDomainOwnership
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This 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)

{}
AppServiceCertificateOrders_RetrieveCertificateActions (new)
Description :  Retrieve the list of certificate actions.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: CertificateOrderAction resource specific properties ,
Required: False ,
}
{
type:
{
Description: Action type. ,
Enum:
{
CertificateIssued: No description available. ,
CertificateOrderCanceled: No description available. ,
CertificateOrderCreated: No description available. ,
CertificateRevoked: No description available. ,
DomainValidationComplete: No description available. ,
FraudDetected: No description available. ,
OrgNameChange: No description available. ,
OrgValidationComplete: No description available. ,
SanDrop: No description available. ,
FraudCleared: No description available. ,
CertificateExpired: No description available. ,
CertificateExpirationWarning: No description available. ,
FraudDocumentationRequired: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Time at which the certificate action was performed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_RetrieveCertificateEmailHistory (new)
Description :  Retrieve email history.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: CertificateEmail resource specific properties ,
Required: False ,
}
{
emailId:
{
Description: Email id. ,
Required: False ,
}
string ,
timeStamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateRegistrationProvider_ListOperations (new)
Description :  Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Required: False ,
}
string ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
CertificateOrders_GetCertificate (new)
Description :  Get certificate associated with the certificate order
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Certificate name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
CertificateOrders_CreateOrUpdateCertificate (new)
Description :  Associates a Key Vault secret to a certificate store that will be used for storing the certificate once it's ready
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Certificate name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
keyVaultCertificate:
{
Description: Key Vault secret csm Id ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
CertificateOrders_DeleteCertificate (new)
Description :  Deletes the certificate associated with the certificate order
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Certificate name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
CertificateOrders_UpdateCertificate (new)
Description :  Associates a Key Vault secret to a certificate store that will be used for storing the certificate once it's ready
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Certificate name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
keyVaultCertificate:
{
Description: Key Vault secret csm Id ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
CertificateOrders_GetCertificateOrder (new)
Description :  Get a certificate order
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateOrders_CreateOrUpdateCertificateOrder (new)
Description :  Create or update a certificate purchase order
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
certificateDistinguishedName:
{
Description: Distinguished name to be used for purchasing certificate ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateOrders_DeleteCertificateOrder (new)
Description :  Delete an existing certificate order
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
CertificateOrders_UpdateCertificateOrder (new)
Description :  Create or update a certificate purchase order
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
certificateDistinguishedName:
{
Description: Distinguished name to be used for purchasing certificate ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateOrders_GetCertificateOrders (new)
Description :  Get certificate orders in a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
CertificateOrders_GetCertificates (new)
Description :  List all certificates associated with a certificate order (only one certificate can be associated with an order at a time)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Certificate name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
CertificateOrders_ReissueCertificateOrder (new)
Description :  Reissue an existing certificate order
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/reissue
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
reissueCertificateOrderRequest:
{
Description: Reissue parameters ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
delayExistingRevokeInHours:
{
Description: Delay in hours to revoke existing certificate after the new certificate is issued ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
CertificateOrders_RenewCertificateOrder (new)
Description :  Renew an existing certificate order
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/renew
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
renewCertificateOrderRequest:
{
Description: Renew parameters ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
CertificateOrders_RetrieveCertificateActions (new)
Description :  Retrieve the list of certificate actions
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveCertificateActions
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate order name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
type:
{
Description: Type ,
Enum:
{
CertificateIssued: No description available. ,
CertificateOrderCanceled: No description available. ,
CertificateOrderCreated: No description available. ,
CertificateRevoked: No description available. ,
DomainValidationComplete: No description available. ,
FraudDetected: No description available. ,
OrgNameChange: No description available. ,
OrgValidationComplete: No description available. ,
SanDrop: No description available. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: Time at which the certificate action was performed ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateOrders_RetrieveCertificateEmailHistory (new)
Description :  Retrieve email history
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveEmailHistory
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate order name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
emailId:
{
Description: Email id ,
Required: False ,
}
string ,
timeStamp:
{
Description: Time stamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateOrders_ResendCertificateEmail (new)
Description :  Resend certificate email
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/resendEmail
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate order name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
CertificateOrders_VerifyDomainOwnership (new)
Description :  Verify domain ownership for this certificate order
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/verifyDomainOwnership
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate order name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Certificates_GetCertificates (new)
Description :  Get certificates for a subscription in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Certificates_GetCertificate (new)
Description :  Get a certificate by certificate name for a subscription in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
Certificates_CreateOrUpdateCertificate (new)
Description :  Creates or modifies an existing certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate if it exists already. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
Certificates_DeleteCertificate (new)
Description :  Delete a certificate by name in a specified subscription and resourcegroup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate to be deleted. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Certificates_UpdateCertificate (new)
Description :  Creates or modifies an existing certificate.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate if it exists already. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
Certificates_GetCsrs (new)
Description :  Gets the certificate signing requests for a subscription in the specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
Certificates_GetCsr (new)
Description :  Gets a certificate signing request by certificate name for a subscription in the specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
Certificates_CreateOrUpdateCsr (new)
Description :  Creates or modifies an existing certificate signing request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
csrEnvelope:
{
Description: Details of certificate signing request if it exists already. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
Certificates_DeleteCsr (new)
Description :  Delete the certificate signing request.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate signing request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Certificates_UpdateCsr (new)
Description :  Creates or modifies an existing certificate signing request.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
csrEnvelope:
{
Description: Details of certificate signing request if it exists already. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
ClassicMobileServices_GetClassicMobileServices (new)
Description :  Get all mobile services in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the mobile service ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ClassicMobileServices_GetClassicMobileService (new)
Description :  Get a mobile service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of mobile service ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the mobile service ,
Required: False ,
}
string ,
}
,
}
ClassicMobileServices_DeleteClassicMobileService (new)
Description :  Delete a mobile service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of mobile service ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Domains_GetDomains (new)
Description :  Lists domains under a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Domains_GetDomain (new)
Description :  Gets details of a domain
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
Domains_CreateOrUpdateDomain (new)
Description :  Creates a domain
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: >Name of the resource group ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain ,
Required: True ,
}
string ,
domain:
{
Description: Domain registration information ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
Domains_DeleteDomain (new)
Description :  Deletes a domain
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain ,
Required: True ,
}
string ,
forceHardDeleteDomain:
{
Description: If true then the domain will be deleted immediately instead of after 24 hours ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
$schema: object ,
}
Domains_UpdateDomain (new)
Description :  Creates a domain
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: >Name of the resource group ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain ,
Required: True ,
}
string ,
domain:
{
Description: Domain registration information ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
Domains_GetDomainOperation (new)
Description :  Retrieves the latest status of a domain purchase operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain ,
Required: True ,
}
string ,
operationId:
{
Description: Domain purchase operation Id ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (500)

{}
Global_GetSubscriptionPublishingCredentials (new)
Description :  Gets publishing credentials for the subscription owner
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/publishingCredentials
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Global_UpdateSubscriptionPublishingCredentials (new)
Description :  Updates publishing credentials for the subscription owner
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/publishingCredentials
{
requestMessage:
{
Description: requestMessage with new publishing credentials ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Global_GetSubscriptionGeoRegions (new)
Description :  Gets list of available geo regions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions
{
sku:
{
Description: Filter only to regions that support this sku ,
Required: False ,
}
string ,
linuxWorkersEnabled:
{
Description: Filter only to regions that support linux workers ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Region name ,
Required: False ,
}
string ,
description:
{
Description: Region description ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for region ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllCertificates (new)
Description :  Get all certificates for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllServerFarms (new)
Description :  Gets all App Service Plans for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms
{
detailed:
{
Description: False to return a subset of App Service Plan properties, true to return all of the properties. Retrieval of all properties may increase the API latency. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllSites (new)
Description :  Gets all Web Apps for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllHostingEnvironments (new)
Description :  Gets all hostingEnvironments (App Service Environment) for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllManagedHostingEnvironments (new)
Description :  Gets all managed hosting environments for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/managedHostingEnvironments
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the managed hosting environment ,
Required: False ,
}
string ,
location:
{
Description: Location of the managed hosting environment e.g. "West US" ,
Required: False ,
}
string ,
status:
{
Description: Current status of the managed hosting environment ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
virtualNetwork:
{
Description: Description of the managed hosting environment's virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
ipsslAddressCount:
{
Description: Number of ip ssl addresses reserved for the managed hosting environment ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the managed hosting environment ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription of the managed hosting environment (read only) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the managed hosting environment (read only) ,
Required: False ,
}
string ,
environmentIsHealthy:
{
Description: True/false indicating whether the managed hosting environment is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the managed hosting environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the managed hosting environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
apiManagementAccount:
{
Description: Resource id of the api management account associated with this managed hosting environment (read only) ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllClassicMobileServices (new)
Description :  Gets all mobile services for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/classicMobileServices
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the mobile service ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_ListPremierAddOnOffers (new)
Description :  List premier add on offers
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Global_IsHostingEnvironmentNameAvailable (new)
Description :  Whether hosting environment name is available
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable
{
name:
{
Description: Hosting environment name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Global_IsHostingEnvironmentWithLegacyNameAvailable (new)
Description :  Whether hosting environment name is available
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable/{name}
{
name:
{
Description: Hosting environment name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Global_CheckNameAvailability (new)
Description :  Check if 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: False ,
}
string ,
type:
{
Description: Resource type used for verification ,
Required: False ,
}
string ,
isFqdn:
{
Description: Is fully qualified domain name ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Subscription Id ,
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: Required if nameAvailable is false. 'Invalid' indicates the name provided does not match Azure WebApp service’s naming requirements. 'AlreadyExists' indicates that the name is already in use and is therefore unavailable. ,
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
GlobalCertificateOrder_GetAllCertificateOrders (new)
Description :  Lists all domains in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/certificateOrders
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
GlobalCertificateOrder_ValidateCertificatePurchaseInformation (new)
Description :  Validate certificate purchase information
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation
{
certificateOrder:
{
Description: Certificate order ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
GlobalDomainRegistration_GetAllDomains (new)
Description :  Lists all domains in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
GlobalDomainRegistration_GetDomainControlCenterSsoRequest (new)
Description :  Generates a single sign on request for domain management portal
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
url:
{
Description: Url where the single sign on request is to be made ,
Required: False ,
}
string ,
postParameterKey:
{
Description: Post parameter key ,
Required: False ,
}
string ,
postParameterValue:
{
Description: Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value. ,
Required: False ,
}
string ,
}
GlobalDomainRegistration_ValidateDomainPurchaseInformation (new)
Description :  Validates domain registration information
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/validateDomainRegistrationInformation
{
domainRegistrationInput:
{
Description: Domain registration information ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the domain ,
Required: False ,
}
string ,
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
GlobalDomainRegistration_CheckDomainAvailability (new)
Description :  Checks if a domain is available for registration
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability
{
identifier:
{
Description: Name of the domain ,
Required: True ,
}
{
name:
{
Description: Name of the object ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the domain ,
Required: False ,
}
string ,
available:
{
Description: If true then domain can be purchased using CreateDomain Api ,
Required: False ,
}
boolean ,
domainType:
{
Description: Domain type ,
Enum:
{
Regular: No description available. ,
SoftDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
GlobalDomainRegistration_ListDomainRecommendations (new)
Description :  Lists domain recommendations based on keywords
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations
{
parameters:
{
Description: Domain recommendation search parameters ,
Required: True ,
}
{
keywords:
{
Description: Keywords to be used for generating domain recommendations ,
Required: False ,
}
string ,
maxDomainRecommendations:
{
Description: Maximum number of recommendations ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the object ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
GlobalResourceGroups_MoveResources (new)
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources
{
resourceGroupName:
{
Required: True ,
}
string ,
moveResourceEnvelope:
{
Required: True ,
}
{
targetResourceGroup:
{
Required: False ,
}
string ,
resources:
{
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
HostingEnvironments_GetHostingEnvironment (new)
Description :  Get properties of hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
HostingEnvironments_CreateOrUpdateHostingEnvironment (new)
Description :  Create or update a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
hostingEnvironmentEnvelope:
{
Description: Properties of hostingEnvironment (App Service Environment) ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
HostingEnvironments_DeleteHostingEnvironment (new)
Description :  Delete a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
forceDelete:
{
Description: Delete even if the hostingEnvironment (App Service Environment) contains resources ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
HostingEnvironments_GetHostingEnvironmentDiagnostics (new)
Description :  Get diagnostic information for hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name/identifier of the diagnostics ,
Required: False ,
}
string ,
diagnosicsOutput:
{
Description: Diagnostics output ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentDiagnosticsItem (new)
Description :  Get diagnostic information for hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
diagnosticsName:
{
Description: Name of the diagnostics ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name/identifier of the diagnostics ,
Required: False ,
}
string ,
diagnosicsOutput:
{
Description: Diagnostics output ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentCapacities (new)
Description :  Get used, available, and total worker capacity for hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentVips (new)
Description :  Get IP addresses assigned to the hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceIpAddress:
{
Description: Main public vip ,
Required: False ,
}
string ,
internalIpAddress:
{
Description: VNET internal ip address of the hostingEnvironment (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 vips ,
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 VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
}
HostingEnvironments_GetHostingEnvironments (new)
Description :  Get all hostingEnvironments (App Service Environments) in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_RebootHostingEnvironment (new)
Description :  Reboots all machines in a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
HostingEnvironments_GetHostingEnvironmentOperations (new)
Description :  List all currently running operations on the hostingEnvironment (App Service Environment)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
HostingEnvironments_GetHostingEnvironmentOperation (new)
Description :  Get status of an operation on a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
operationId:
{
Description: operation identifier GUID ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (404)

{}

⚐ Response (500)

{}
HostingEnvironments_GetHostingEnvironmentMetrics (new)
Description :  Get global metrics of hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
details:
{
Description: Include instance details ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of metric ,
Required: False ,
}
{
value:
{
Description: metric name value ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values ,
Required: False ,
}
[
{
timeStamp:
{
Description: Value timestamp ,
Required: False ,
}
string ,
average:
{
Description: Value average ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
properties:
{
Description: Properties ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentMetricDefinitions (new)
Description :  Get global metric definitions of hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
HostingEnvironments_GetHostingEnvironmentUsages (new)
Description :  Get global usages of hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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 ,
}
HostingEnvironments_GetHostingEnvironmentMultiRoleMetrics (new)
Description :  Get metrics for a multiRole pool of a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
startTime:
{
Description: Beginning time of metrics query ,
Required: False ,
}
string ,
endTime:
{
Description: End time of metrics query ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time granularity of metrics query ,
Required: False ,
}
string ,
details:
{
Description: Include instance details ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
details:
{
Description: Include instance details ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentWebWorkerMetricDefinitions (new)
Description :  Get metric definitions for a worker pool of a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentMultiRoleUsages (new)
Description :  Get usages for a multiRole pool of a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Comma separated list of site properties to include ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentWebHostingPlans (new)
Description :  Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/webhostingplans
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentServerFarms (new)
Description :  Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetMultiRolePools (new)
Description :  Get all multi role pools
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetMultiRolePool (new)
Description :  Get properties of a multiRole pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
HostingEnvironments_CreateOrUpdateMultiRolePool (new)
Description :  Create or update a multiRole pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
multiRolePoolEnvelope:
{
Description: Properties of multiRole pool ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
HostingEnvironments_GetMultiRolePoolSkus (new)
Description :  Get available skus for scaling a multiRole pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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 ,
}
,
capacity:
{
Description: Min, max, and default scale values of the sku ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service Plan ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetWorkerPools (new)
Description :  Get all worker pools
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetWorkerPool (new)
Description :  Get properties of a worker pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
HostingEnvironments_CreateOrUpdateWorkerPool (new)
Description :  Create or update a worker pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
workerPoolEnvelope:
{
Description: Properties of worker pool ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
HostingEnvironments_GetWorkerPoolSkus (new)
Description :  Get available skus for scaling a worker pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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 ,
}
,
capacity:
{
Description: Min, max, and default scale values of the sku ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service Plan ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetWorkerPoolInstanceMetrics (new)
Description :  Get metrics for a specific instance of a worker pool of a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
instance:
{
Description: Name of instance in the worker pool ,
Required: True ,
}
string ,
details:
{
Description: Include instance details ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
HostingEnvironments_GetWorkerPoolInstanceMetricDefinitions (new)
Description :  Get metric definitions for a specific instance of a worker pool of a hostingEnvironment (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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
instance:
{
Description: Name of instance in the worker pool ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
HostingEnvironments_GetMultiRolePoolInstanceMetrics (new)
Description :  Get metrics for a specific instance of a multiRole pool of a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
instance:
{
Description: Name of instance in the multiRole pool ,
Required: True ,
}
string ,
details:
{
Description: Include instance details ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
HostingEnvironments_GetMultiRolePoolInstanceMetricDefinitions (new)
Description :  Get metric definitions for a specific instance of a multiRole pool of a hostingEnvironment (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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
instance:
{
Description: Name of instance in the multiRole pool> ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
HostingEnvironments_SuspendHostingEnvironment (new)
Description :  Suspends the hostingEnvironment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_ResumeHostingEnvironment (new)
Description :  Resumes the hostingEnvironment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedHostingEnvironments_GetManagedHostingEnvironment (new)
Description :  Get properties of a managed hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the managed hosting environment ,
Required: False ,
}
string ,
location:
{
Description: Location of the managed hosting environment e.g. "West US" ,
Required: False ,
}
string ,
status:
{
Description: Current status of the managed hosting environment ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
virtualNetwork:
{
Description: Description of the managed hosting environment's virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
ipsslAddressCount:
{
Description: Number of ip ssl addresses reserved for the managed hosting environment ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the managed hosting environment ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription of the managed hosting environment (read only) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the managed hosting environment (read only) ,
Required: False ,
}
string ,
environmentIsHealthy:
{
Description: True/false indicating whether the managed hosting environment is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the managed hosting environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the managed hosting environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
apiManagementAccount:
{
Description: Resource id of the api management account associated with this managed hosting environment (read only) ,
Required: False ,
}
string ,
}
,
}
ManagedHostingEnvironments_CreateOrUpdateManagedHostingEnvironment (new)
Description :  Create or update a managed hosting environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
ManagedHostingEnvironmentEnvelope:
{
Description: Properties of managed hosting environment ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
ManagedHostingEnvironments_DeleteManagedHostingEnvironment (new)
Description :  Delete a managed hosting environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
forceDelete:
{
Description: Delete even if the managed hosting environment contains resources ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
ManagedHostingEnvironments_GetManagedHostingEnvironments (new)
Description :  Get all managed hosting environments in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedHostingEnvironments_GetManagedHostingEnvironmentVips (new)
Description :  Get list of ip addresses assigned to a managed hosting environment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/capacities/virtualip
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceIpAddress:
{
Description: Main public vip ,
Required: False ,
}
string ,
internalIpAddress:
{
Description: VNET internal ip address of the hostingEnvironment (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 vips ,
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 VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
}
ManagedHostingEnvironments_GetManagedHostingEnvironmentOperation (new)
Description :  Get status of an operation on a managed hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/operations/{operationId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
operationId:
{
Description: operation identifier GUID ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (404)

{}

⚐ Response (500)

{}
ManagedHostingEnvironments_GetManagedHostingEnvironmentSites (new)
Description :  Get all sites on the managed hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/sites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Comma separated list of site properties to include ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedHostingEnvironments_GetManagedHostingEnvironmentWebHostingPlans (new)
Description :  Get all serverfarms (App Service Plans) on the managed hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/webhostingplans
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedHostingEnvironments_GetManagedHostingEnvironmentServerFarms (new)
Description :  Get all serverfarms (App Service Plans) on the managed hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/serverfarms
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Provider_GetSourceControls (new)
Description :  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: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name or Source Control Type ,
Required: False ,
}
string ,
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 ,
}
Provider_GetSourceControl (new)
Description :  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:
{
Required: False ,
}
{
name:
{
Description: Name or Source Control Type ,
Required: False ,
}
string ,
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 ,
}
,
}
Provider_UpdateSourceControl (new)
Description :  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:
{
Required: False ,
}
{
name:
{
Description: Name or Source Control Type ,
Required: False ,
}
string ,
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:
{
Required: False ,
}
{
name:
{
Description: Name or Source Control Type ,
Required: False ,
}
string ,
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 ,
}
,
}
Provider_GetPublishingUser (new)
Description :  Gets publishing user
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Provider_UpdatePublishingUser (new)
Description :  Updates publishing user
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Web/publishingUsers/web
{
requestMessage:
{
Description: Details of publishing user ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Recommendations_GetRecommendationBySubscription (new)
Description :  Gets a list of recommendations associated with the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations
{
featured:
{
Description: If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification' ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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. ,
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. ,
Required: False ,
}
string ,
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: Localized text of recommendation, good for UI. ,
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: True ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
All: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
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: On/off flag indicating the rule is currently enabled or disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The beginning time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp 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 ,
}
Recommendations_GetRuleDetailsBySiteName (new)
Description :  Gets the detailed properties of the recommendation object for the specified web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}
{
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
name:
{
Description: Recommendation rule name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
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. ,
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 ,
enabled:
{
Description: On/off flag indicating the rule is currently enabled or disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
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: True ,
}
enum ,
channels:
{
Description: List of available channels that this rule applies. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
All: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
Description: An array of category tags that the rule contains. ,
Required: False ,
}
[
string ,
]
,
}
Recommendations_GetRecommendedRulesForSite (new)
Description :  Gets a list of recommendations associated with the specified web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations
{
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
featured:
{
Description: If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available ,
Required: False ,
}
boolean ,
siteSku:
{
Description: The name of site SKU. ,
Required: False ,
}
string ,
numSlots:
{
Description: The number of site slots associated to the site ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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. ,
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. ,
Required: False ,
}
string ,
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: Localized text of recommendation, good for UI. ,
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: True ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
All: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
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: On/off flag indicating the rule is currently enabled or disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The beginning time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp 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 ,
}
Recommendations_GetRecommendationHistoryForSite (new)
Description :  Gets the list of past recommendations optionally specified by the time range.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory
{
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of a time range to query, e.g. $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq '2015-01-02T00:00:00Z' ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of a time range to query, e.g. $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq '2015-01-02T00:00:00Z' ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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. ,
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. ,
Required: False ,
}
string ,
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: Localized text of recommendation, good for UI. ,
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: True ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
All: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
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: On/off flag indicating the rule is currently enabled or disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The beginning time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp 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 ,
}
ServerFarms_GetServerFarms (new)
Description :  Gets collection of App Service Plans in a resource group for a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ServerFarms_GetServerFarm (new)
Description :  Gets specified App Service Plan in a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
ServerFarms_CreateOrUpdateServerFarm (new)
Description :  Creates or updates an App Service Plan
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
serverFarmEnvelope:
{
Description: Details of App Service Plan ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
allowPendingState:
{
Description: OBSOLETE: If true, allow pending state for App Service Plan ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
ServerFarms_DeleteServerFarm (new)
Description :  Deletes a App Service Plan
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
ServerFarms_GetServerFarmMetrics (new)
Description :  Queries for App Service Plan metrics
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
details:
{
Description: If true, metrics are broken down per App Service Plan instance ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of metric ,
Required: False ,
}
{
value:
{
Description: metric name value ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values ,
Required: False ,
}
[
{
timeStamp:
{
Description: Value timestamp ,
Required: False ,
}
string ,
average:
{
Description: Value average ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
properties:
{
Description: Properties ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ServerFarms_GetServerFarmMetricDefintions (new)
Description :  List of metrics that can be queried for an App Service Plan
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ServerFarms_GetVnetsForServerFarm (new)
Description :  Gets list of VNets associated with App Service Plan
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
ServerFarms_GetVnetFromServerFarm (new)
Description :  Gets a vnet 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
ServerFarms_GetRoutesForVnet (new)
Description :  Gets a list of all routes associated with a vnet, 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
ServerFarms_GetRouteForVnet (new)
Description :  Gets a specific route associated with a vnet, 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the virtual network route ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
ServerFarms_CreateOrUpdateVnetRoute (new)
Description :  Creates a new route or updates an existing route for a vnet 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the virtual network route ,
Required: True ,
}
string ,
route:
{
Description: The route object ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}
ServerFarms_DeleteVnetRoute (new)
Description :  Deletes an existing route for a vnet 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the virtual network route ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (404)

{}
ServerFarms_UpdateVnetRoute (new)
Description :  Creates a new route or updates an existing route for a vnet 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the virtual network route ,
Required: True ,
}
string ,
route:
{
Description: The route object ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}
ServerFarms_GetServerFarmVnetGateway (new)
Description :  Gets the vnet gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
ServerFarms_UpdateServerFarmVnetGateway (new)
Description :  Updates the vnet gateway
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
name:
{
Description: The name of the App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the virtual network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. Only 'primary' is supported. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The gateway entity. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
ServerFarms_GetServerFarmSites (new)
Description :  Gets list of 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
$skipToken:
{
Description: Skip to of web apps in a list. If specified, the resulting list will contain web apps starting from (including) the skipToken. Else, the resulting list contains web apps from the start of the list ,
Required: False ,
}
string ,
$filter:
{
Description: Supported filter: $filter=state eq running. Returns only web apps that are currently running ,
Required: False ,
}
string ,
$top:
{
Description: List page size. If specified, results are paged. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ServerFarms_RebootWorkerForServerFarm (new)
Description :  Submit a reboot request for a worker machine in the specified server farm
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of server farm ,
Required: True ,
}
string ,
workerName:
{
Description: Name of worker machine, typically starts with RD ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
ServerFarms_RestartSitesForServerFarm (new)
Description :  Restarts web apps in a specified App Service Plan
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
softRestart:
{
Description: Soft restart applies the configuration settings and restarts the apps if necessary. Hard restart always restarts and reprovisions the apps ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
ServerFarms_GetServerFarmOperation (new)
Description :  Gets a server farm operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of server farm ,
Required: True ,
}
string ,
operationId:
{
Description: Id of Server farm operation"> ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
Sites_GetSiteVNETConnectionSlot (new)
Description :  Retrieves a specific Virtual Network Connection associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_CreateOrUpdateSiteVNETConnectionSlot (new)
Description :  Adds a Virtual Network Connection or updates it's properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties of this Virtual Network Connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteSiteVNETConnectionSlot (new)
Description :  Removes the specified Virtual Network Connection association from this web app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteVNETConnectionSlot (new)
Description :  Adds a Virtual Network Connection or updates it's properties.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties of this Virtual Network Connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteVNETConnection (new)
Description :  Retrieves a specific Virtual Network Connection associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_CreateOrUpdateSiteVNETConnection (new)
Description :  Adds a Virtual Network Connection or updates it's properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties of this Virtual Network Connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteSiteVNETConnection (new)
Description :  Removes the specified Virtual Network Connection association from this web app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteVNETConnection (new)
Description :  Adds a Virtual Network Connection or updates it's properties.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties of this Virtual Network Connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteNetworkFeaturesSlot (new)
Description :  Retrieves a view of all network features in use on this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
view:
{
Description: The type of view. This can either be "summary" or "detailed". ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
virtualNetworkName:
{
Description: The Vnet Name ,
Required: False ,
}
string ,
virtualNetworkConnection:
{
Description: The Vnet Summary view ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
hybridConnections:
{
Description: The Hybrid Connections Summary view ,
Required: False ,
}
[
{
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 (404)

{}
Sites_GetSiteNetworkFeatures (new)
Description :  Retrieves a view of all network features in use on this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
view:
{
Description: The type of view. This can either be "summary" or "detailed". ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
virtualNetworkName:
{
Description: The Vnet Name ,
Required: False ,
}
string ,
virtualNetworkConnection:
{
Description: The Vnet Summary view ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
hybridConnections:
{
Description: The Hybrid Connections Summary view ,
Required: False ,
}
[
{
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 (404)

{}
Sites_GetSiteOperationSlot (new)
Description :  Gets the operation for a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
operationId:
{
Description: Id of an operation ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteOperation (new)
Description :  Gets the operation for a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
operationId:
{
Description: Id of an operation ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_SwapSlotWithProduction (new)
Description :  Swaps web app slots
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
$schema: object ,
}
Sites_SwapSlotsSlot (new)
Description :  Swaps web app slots
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
slot:
{
Description: Name of source slot for the swap ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
$schema: object ,
}
Sites_GetSlotsDifferencesFromProduction (new)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
type:
{
Description: Indicates the type of the difference: Information, Warning or Error. ,
Required: False ,
}
string ,
settingType:
{
Description: The type of the settings: General, AppSetting or ConnectionString ,
Required: False ,
}
string ,
diffRule:
{
Description: Rule that describes how to process the difference in settings during web app slot swap. ,
Required: False ,
}
string ,
settingName:
{
Description: Name of the setting ,
Required: False ,
}
string ,
valueInCurrentSlot:
{
Description: Value of the setting in the current web app slot ,
Required: False ,
}
string ,
valueInTargetSlot:
{
Description: Value of the setting in the target web app slot ,
Required: False ,
}
string ,
description:
{
Description: Description of the difference ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSlotsDifferencesSlot (new)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
slot:
{
Description: Name of the source slot ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
type:
{
Description: Indicates the type of the difference: Information, Warning or Error. ,
Required: False ,
}
string ,
settingType:
{
Description: The type of the settings: General, AppSetting or ConnectionString ,
Required: False ,
}
string ,
diffRule:
{
Description: Rule that describes how to process the difference in settings during web app slot swap. ,
Required: False ,
}
string ,
settingName:
{
Description: Name of the setting ,
Required: False ,
}
string ,
valueInCurrentSlot:
{
Description: Value of the setting in the current web app slot ,
Required: False ,
}
string ,
valueInTargetSlot:
{
Description: Value of the setting in the target web app slot ,
Required: False ,
}
string ,
description:
{
Description: Description of the difference ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_ApplySlotConfigToProduction (new)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name. Settings from that slot will be applied on the source slot ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_ApplySlotConfigSlot (new)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name. Settings from that slot will be applied on the source slot ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
slot:
{
Description: Name of the source slot. Settings from the target slot will be applied onto this slot ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_ResetProductionSlotConfig (new)
Description :  Resets the configuration settings of the current slot if they were previously modified by calling ApplySlotConfig API
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_ResetSlotConfigSlot (new)
Description :  Resets the configuration settings of the current slot if they were previously modified by calling ApplySlotConfig API
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSlotConfigNames (new)
Description :  Gets the names of application settings and connection string that remain with the slot during swap operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionStringNames:
{
Description: List of connection string names ,
Required: False ,
}
[
string ,
]
,
appSettingNames:
{
Description: List of application settings names ,
Required: False ,
}
[
string ,
]
,
}
,
}
Sites_UpdateSlotConfigNames (new)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotConfigNames:
{
Description: Request body containing the names of application settings and connection strings ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
connectionStringNames:
{
Description: List of connection string names ,
Required: False ,
}
[
string ,
]
,
appSettingNames:
{
Description: List of application settings names ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionStringNames:
{
Description: List of connection string names ,
Required: False ,
}
[
string ,
]
,
appSettingNames:
{
Description: List of application settings names ,
Required: False ,
}
[
string ,
]
,
}
,
}
Sites_GetSiteSlots (new)
Description :  Gets all the slots for a web apps
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: List of app properties to include in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSites (new)
Description :  Gets the web apps for a subscription in the specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
includeSiteTypes:
{
Description: Types of apps included in the response ,
Required: False ,
}
string ,
includeSlots:
{
Description: Whether or not to include deployments slots in results ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSite (new)
Description :  Get details of a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_CreateOrUpdateSite (new)
Description :  Creates a new web app or modifies an existing web app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the web app ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: Details of web app if it exists already ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
skipDnsRegistration:
{
Description: If true web app hostname is not registered with DNS on creation. This parameter is only used for app creation ,
Required: False ,
}
string ,
skipCustomDomainVerification:
{
Description: If true, custom (non *.azurewebsites.net) domains associated with web app are not verified. ,
Required: False ,
}
string ,
forceDnsRegistration:
{
Description: If true, web app hostname is force registered with DNS ,
Required: False ,
}
string ,
ttlInSeconds:
{
Description: Time to live in seconds for web app's default domain name ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteSite (new)
Description :  Deletes a web app
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
deleteMetrics:
{
Description: If true, web app metrics are also deleted ,
Required: False ,
}
string ,
deleteEmptyServerFarm:
{
Description: If true and App Service Plan is empty after web app deletion, App Service Plan is also deleted ,
Required: False ,
}
string ,
skipDnsRegistration:
{
Description: If true, DNS registration is skipped ,
Required: False ,
}
string ,
deleteAllSlots:
{
Description: If true, all slots associated with web app are also deleted ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteSlot (new)
Description :  Get details of a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of resource group ,
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 ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_CreateOrUpdateSiteSlot (new)
Description :  Creates a new web app or modifies an existing web app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the web app ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: Details of web app if it exists already ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
skipDnsRegistration:
{
Description: If true web app hostname is not registered with DNS on creation. This parameter is only used for app creation ,
Required: False ,
}
string ,
skipCustomDomainVerification:
{
Description: If true, custom (non *.azurewebsites.net) domains associated with web app are not verified. ,
Required: False ,
}
string ,
forceDnsRegistration:
{
Description: If true, web app hostname is force registered with DNS ,
Required: False ,
}
string ,
ttlInSeconds:
{
Description: Time to live in seconds for web app's default domain name ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteSiteSlot (new)
Description :  Deletes a web app
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of resource group ,
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 ,
deleteMetrics:
{
Description: If true, web app metrics are also deleted ,
Required: False ,
}
string ,
deleteEmptyServerFarm:
{
Description: If true and App Service Plan is empty after web app deletion, App Service Plan is also deleted ,
Required: False ,
}
string ,
skipDnsRegistration:
{
Description: If true, DNS registration is skipped ,
Required: False ,
}
string ,
deleteAllSlots:
{
Description: If true, all slots associated with web app are also deleted ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_IsSiteCloneable (new)
Description :  Creates a new web app or modifies an existing web app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
result:
{
Description: Name of web app ,
Enum:
{
Cloneable: No description available. ,
PartiallyCloneable: No description available. ,
NotCloneable: No description available. ,
}
,
Required: True ,
}
enum ,
blockingFeatures:
{
Description: List of features enabled on web 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 web app that are non-blocking but cannot be cloned. The web app can still be cloned but the features in this list will not be set up on cloned web 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 ,
}
,
]
,
}
Sites_IsSiteCloneableSlot (new)
Description :  Creates a new web app or modifies an existing web app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the 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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
result:
{
Description: Name of web app ,
Enum:
{
Cloneable: No description available. ,
PartiallyCloneable: No description available. ,
NotCloneable: No description available. ,
}
,
Required: True ,
}
enum ,
blockingFeatures:
{
Description: List of features enabled on web 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 web app that are non-blocking but cannot be cloned. The web app can still be cloned but the features in this list will not be set up on cloned web 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 ,
}
,
]
,
}
Sites_RecoverSite (new)
Description :  Recovers a deleted web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
recoveryEntity:
{
Description: Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. ,
Required: True ,
}
{
snapshotTime:
{
Description: Point in time in which the site recover should be attempted. ,
Format: date-time ,
Required: False ,
}
string ,
recoverConfig:
{
Description: If true, then the website's configuration will be reverted to its state at SnapshotTime ,
Required: False ,
}
boolean ,
siteName:
{
Description: [Optional] Destination web app name into which web app should be recovered. This is case when new web app should be created instead. ,
Required: False ,
}
string ,
slotName:
{
Description: [Optional] Destination web app slot name into which web app should be recovered ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
Sites_RecoverSiteSlot (new)
Description :  Recovers a deleted web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
recoveryEntity:
{
Description: Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. ,
Required: True ,
}
{
snapshotTime:
{
Description: Point in time in which the site recover should be attempted. ,
Format: date-time ,
Required: False ,
}
string ,
recoverConfig:
{
Description: If true, then the website's configuration will be reverted to its state at SnapshotTime ,
Required: False ,
}
boolean ,
siteName:
{
Description: [Optional] Destination web app name into which web app should be recovered. This is case when new web app should be created instead. ,
Required: False ,
}
string ,
slotName:
{
Description: [Optional] Destination web app slot name into which web app should be recovered ,
Required: False ,
}
string ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
Sites_GetSiteSnapshots (new)
Description :  Returns all Snapshots to the user.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots
{
resourceGroupName:
{
Description: Webspace ,
Required: True ,
}
string ,
name:
{
Description: Website Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteSnapshotsSlot (new)
Description :  Returns all Snapshots to the user.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots
{
resourceGroupName:
{
Description: Webspace ,
Required: True ,
}
string ,
name:
{
Description: Website Name ,
Required: True ,
}
string ,
slot:
{
Description: Website Slot ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetDeletedSites (new)
Description :  Gets deleted web apps in subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/deletedSites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
includeSiteTypes:
{
Description: Types of apps included in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
deletedTimestamp:
{
Description: Time when the site was deleted ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetDeployments (new)
Description :  List deployments
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetDeploymentsSlot (new)
Description :  List deployments
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetInstanceDeployments (new)
Description :  List deployments
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
instanceId:
{
Description: Id of web app instance ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetInstanceDeploymentsSlot (new)
Description :  List deployments
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetInstanceDeployment (new)
Description :  Get the deployment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
instanceId:
{
Description: Id of web app instance ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_CreateInstanceDeployment (new)
Description :  Create a deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
instanceId:
{
Description: Id of web app instance ,
Required: True ,
}
string ,
deployment:
{
Description: Details of deployment ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteInstanceDeployment (new)
Description :  Delete the deployment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
instanceId:
{
Description: Id of web app instance ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetDeployment (new)
Description :  Get the deployment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_CreateDeployment (new)
Description :  Create a deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
deployment:
{
Description: Details of deployment ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteDeployment (new)
Description :  Delete the deployment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetDeploymentSlot (new)
Description :  Get the deployment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_CreateDeploymentSlot (new)
Description :  Create a deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
deployment:
{
Description: Details of deployment ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteDeploymentSlot (new)
Description :  Delete the deployment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetInstanceDeploymentSlot (new)
Description :  Get the deployment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_CreateInstanceDeploymentSlot (new)
Description :  Create a deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
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 ,
deployment:
{
Description: Details of deployment ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteInstanceDeploymentSlot (new)
Description :  Delete the deployment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteInstanceIdentifiers (new)
Description :  Gets all instance of a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of instance ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteInstanceIdentifiersSlot (new)
Description :  Gets all instance of a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of instance ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteHostNameBindings (new)
Description :  Get web app hostname bindings
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteHostNameBindingsSlot (new)
Description :  Get web app hostname bindings
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteHostNameBinding (new)
Description :  Get web app binding for a hostname
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
hostName:
{
Description: Name of host ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Sites_CreateOrUpdateSiteHostNameBinding (new)
Description :  Creates a web app hostname binding
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
hostName:
{
Description: Name of host ,
Required: True ,
}
string ,
hostNameBinding:
{
Description: Host name binding information ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Sites_DeleteSiteHostNameBinding (new)
Description :  Deletes a host name binding
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
hostName:
{
Description: Name of host ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteHostNameBindingSlot (new)
Description :  Get web app binding for a hostname
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
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: Name of host ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Sites_CreateOrUpdateSiteHostNameBindingSlot (new)
Description :  Creates a web app hostname binding
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
hostName:
{
Description: Name of host ,
Required: True ,
}
string ,
hostNameBinding:
{
Description: Host name binding information ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Sites_DeleteSiteHostNameBindingSlot (new)
Description :  Deletes a host name binding
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
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: Name of host ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteConfig (new)
Description :  Gets the configuration of the web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_CreateOrUpdateSiteConfig (new)
Description :  Update the configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_UpdateSiteConfig (new)
Description :  Update the configuration of web app
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_GetSiteConfigSlot (new)
Description :  Gets the configuration of the web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_CreateOrUpdateSiteConfigSlot (new)
Description :  Update the configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_UpdateSiteConfigSlot (new)
Description :  Update the configuration of web app
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_GetSiteSourceControl (new)
Description :  Get the source control configuration of web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_CreateOrUpdateSiteSourceControl (new)
Description :  Update the source control configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: Request body that contains the source control parameters ,
Required: True ,
}
{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_DeleteSiteSourceControl (new)
Description :  Delete source control configuration of web app
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteSourceControl (new)
Description :  Update the source control configuration of web app
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: Request body that contains the source control parameters ,
Required: True ,
}
{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_GetSiteSourceControlSlot (new)
Description :  Get the source control configuration of web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_CreateOrUpdateSiteSourceControlSlot (new)
Description :  Update the source control configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: Request body that contains the source control parameters ,
Required: True ,
}
{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_DeleteSiteSourceControlSlot (new)
Description :  Delete source control configuration of web app
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteSourceControlSlot (new)
Description :  Update the source control configuration of web app
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: Request body that contains the source control parameters ,
Required: True ,
}
{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_ListSiteAppSettingsSlot (new)
Description :  Gets the application settings of web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_ListSiteAppSettings (new)
Description :  Gets the application settings of web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteAppSettings (new)
Description :  Updates the application settings of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
appSettings:
{
Description: Application settings of web app ,
Required: True ,
}
{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteAppSettingsSlot (new)
Description :  Updates the application settings of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
appSettings:
{
Description: Application settings of web app ,
Required: True ,
}
{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_ListSiteConnectionStrings (new)
Description :  Gets the connection strings associated with web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
Sites_ListSiteConnectionStringsSlot (new)
Description :  Gets the connection strings associated with web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteConnectionStrings (new)
Description :  Updates the connection strings associated with web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
connectionStrings:
{
Description: Connection strings associated with web app ,
Required: True ,
}
{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteConnectionStringsSlot (new)
Description :  Updates the connection strings associated with web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
connectionStrings:
{
Description: Connection strings associated with web app ,
Required: True ,
}
{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
Sites_ListSiteAuthSettings (new)
Description :  Gets the Authentication / Authorization settings associated with web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
Sites_ListSiteAuthSettingsSlot (new)
Description :  Gets the Authentication / Authorization settings associated with web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
Sites_UpdateSiteAuthSettings (new)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteAuthSettings:
{
Description: Auth settings associated with web app ,
Required: True ,
}
{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
Sites_UpdateSiteAuthSettingsSlot (new)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteAuthSettings:
{
Description: Auth settings associated with web app ,
Required: True ,
}
{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
Sites_ListSitePublishingCredentials (new)
Description :  Gets the web app publishing credentials
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Sites_ListSitePublishingCredentialsSlot (new)
Description :  Gets the web app publishing credentials
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Sites_ListSiteMetadata (new)
Description :  Gets the web app meta data.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_ListSiteMetadataSlot (new)
Description :  Gets the web app meta data.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteMetadata (new)
Description :  Updates the meta data for web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
metadata:
{
Description: Meta data of web app ,
Required: True ,
}
{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteMetadataSlot (new)
Description :  Updates the meta data for web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
metadata:
{
Description: Meta data of web app ,
Required: True ,
}
{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_GetSiteLogsConfig (new)
Description :  Gets the web app logs configuration
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
Sites_UpdateSiteLogsConfig (new)
Description :  Updates the meta data for web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteLogsConfig:
{
Description: Site logs configuration ,
Required: True ,
}
{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
Sites_GetSiteLogsConfigSlot (new)
Description :  Gets the web app logs configuration
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
Sites_UpdateSiteLogsConfigSlot (new)
Description :  Updates the meta data for web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteLogsConfig:
{
Description: Site logs configuration ,
Required: True ,
}
{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
Sites_ListSitePremierAddOns (new)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_ListSitePremierAddOnsSlot (new)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
slot:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSitePremierAddOn (new)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_AddSitePremierAddOn (new)
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
premierAddOn:
{
Required: True ,
}
{
location:
{
Description: Geo 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 ,
}
object ,
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 ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_DeleteSitePremierAddOn (new)
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSitePremierAddOnSlot (new)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
slot:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_AddSitePremierAddOnSlot (new)
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
premierAddOn:
{
Required: True ,
}
{
location:
{
Description: Geo 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 ,
}
object ,
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 ,
}
,
}
,
slot:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_DeleteSitePremierAddOnSlot (new)
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
slot:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteBackupConfiguration (new)
Description :  Gets the backup configuration for a web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Sites_GetSiteBackupConfigurationSlot (new)
Description :  Gets the backup configuration for a web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Sites_UpdateSiteBackupConfiguration (new)
Description :  Updates backup configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on backup request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Sites_UpdateSiteBackupConfigurationSlot (new)
Description :  Updates backup configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on backup request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Sites_BackupSite (new)
Description :  Creates web app backup
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on backup request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_BackupSiteSlot (new)
Description :  Creates web app backup
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on backup request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_DiscoverSiteRestore (new)
Description :  Discovers existing web app backups that can be restored
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
Sites_DiscoverSiteRestoreSlot (new)
Description :  Discovers existing web app backups that can be restored
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
Sites_ListSiteBackups (new)
Description :  Lists all available backups for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
Sites_ListSiteBackupsSlot (new)
Description :  Lists all available backups for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
Sites_GetSiteBackupStatus (new)
Description :  Gets status of a web app backup that may be in progress.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_DeleteBackup (new)
Description :  Deletes a backup from Azure Storage
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_GetSiteBackupStatusSlot (new)
Description :  Gets status of a web app backup that may be in progress.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_DeleteBackupSlot (new)
Description :  Deletes a backup from Azure Storage
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_GetSiteBackupStatusSecretsSlot (new)
Description :  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 resource group ,
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:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_GetSiteBackupStatusSecrets (new)
Description :  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 resource group ,
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:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_RestoreSite (new)
Description :  Restores a web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup to restore ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
operationId:
{
Description: When server starts the restore process, it will return an OperationId identifying that particular restore operation ,
Required: False ,
}
string ,
}
,
}
Sites_RestoreSiteSlot (new)
Description :  Restores a web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup to restore ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
operationId:
{
Description: When server starts the restore process, it will return an OperationId identifying that particular restore operation ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteUsages (new)
Description :  Gets the quota usage numbers for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
$filter:
{
Description: Return only usages specified in the filter. Filter is specified by using OData syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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 ,
}
Sites_GetSiteUsagesSlot (new)
Description :  Gets the quota usage numbers for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages
{
resourceGroupName:
{
Description: Name of resource group ,
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 ,
$filter:
{
Description: Return only usages specified in the filter. Filter is specified by using OData syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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 ,
}
Sites_GetSiteMetrics (new)
Description :  Gets metrics for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
details:
{
Description: If true, metric details are included in response ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of metric ,
Required: False ,
}
{
value:
{
Description: metric name value ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values ,
Required: False ,
}
[
{
timeStamp:
{
Description: Value timestamp ,
Required: False ,
}
string ,
average:
{
Description: Value average ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
properties:
{
Description: Properties ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteMetricsSlot (new)
Description :  Gets metrics for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
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 ,
details:
{
Description: If true, metric details are included in response ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of metric ,
Required: False ,
}
{
value:
{
Description: metric name value ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values ,
Required: False ,
}
[
{
timeStamp:
{
Description: Value timestamp ,
Required: False ,
}
string ,
average:
{
Description: Value average ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
properties:
{
Description: Properties ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteMetricDefinitionsSlot (new)
Description :  Gets metric definitions for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteMetricDefinitions (new)
Description :  Gets metric definitions for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_ListSitePublishingProfileXml (new)
Description :  Gets the publishing profile for web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
options:
{
Description: Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format. ,
Required: True ,
}
{
format:
{
Description: Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}
Sites_ListSitePublishingProfileXmlSlot (new)
Description :  Gets the publishing profile for web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
options:
{
Description: Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format. ,
Required: True ,
}
{
format:
{
Description: Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp ,
Required: False ,
}
string ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}
Sites_RestartSiteSlot (new)
Description :  Restarts web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart
{
resourceGroupName:
{
Description: Name of resource group ,
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 ,
softRestart:
{
Description: Soft restart applies the configuration settings and restarts the app if necessary. Hard restart always restarts and reprovisions the app ,
Required: False ,
}
boolean ,
synchronous:
{
Description: If true then the API will block until the app has been restarted ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_RestartSite (new)
Description :  Restarts web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
softRestart:
{
Description: Soft restart applies the configuration settings and restarts the app if necessary. Hard restart always restarts and reprovisions the app ,
Required: False ,
}
boolean ,
synchronous:
{
Description: If true then the API will block until the app has been restarted ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_StartSite (new)
Description :  Starts web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_StartSiteSlot (new)
Description :  Starts web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_StopSite (new)
Description :  Stops web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_StopSiteSlot (new)
Description :  Stops web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_SyncSiteRepository (new)
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_SyncSiteRepositorySlot (new)
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
slot:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GenerateNewSitePublishingPasswordSlot (new)
Description :  Generates new random app publishing password
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GenerateNewSitePublishingPassword (new)
Description :  Generates new random app publishing password
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteRelayServiceConnection (new)
Description :  Retrieves a BizTalk Hybrid Connection identified by its entity name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_CreateOrUpdateSiteRelayServiceConnection (new)
Description :  Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the Hybrid Connection ,
Required: True ,
}
{
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_DeleteSiteRelayServiceConnection (new)
Description :  Removes the association to a BizTalk Hybrid Connection, identified by its entity name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteRelayServiceConnection (new)
Description :  Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the Hybrid Connection ,
Required: True ,
}
{
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_GetSiteRelayServiceConnectionSlot (new)
Description :  Retrieves a BizTalk Hybrid Connection identified by its entity name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for the web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_CreateOrUpdateSiteRelayServiceConnectionSlot (new)
Description :  Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the Hybrid Connection ,
Required: True ,
}
{
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: The name of the slot for the web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_DeleteSiteRelayServiceConnectionSlot (new)
Description :  Removes the association to a BizTalk Hybrid Connection, identified by its entity name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for the web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteRelayServiceConnectionSlot (new)
Description :  Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the Hybrid Connection ,
Required: True ,
}
{
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: The name of the slot for the web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_ListSiteRelayServiceConnectionsSlot (new)
Description :  Retrieves all BizTalk Hybrid Connections associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection
{
resourceGroupName:
{
Description: The resource group name ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_ListSiteRelayServiceConnections (new)
Description :  Retrieves all BizTalk Hybrid Connections associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_GetSiteVnetGatewaySlot (new)
Description :  Retrieves a Virtual Network connection gateway associated with this web app and virtual network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (404)

{}
Sites_CreateOrUpdateSiteVNETConnectionGatewaySlot (new)
Description :  Updates the Virtual Network Gateway.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties to update this gateway with. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
Sites_UpdateSiteVNETConnectionGatewaySlot (new)
Description :  Updates the Virtual Network Gateway.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties to update this gateway with. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteVnetGateway (new)
Description :  Retrieves a Virtual Network connection gateway associated with this web app and virtual network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (404)

{}
Sites_CreateOrUpdateSiteVNETConnectionGateway (new)
Description :  Updates the Virtual Network Gateway.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties to update this gateway with. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
Sites_UpdateSiteVNETConnectionGateway (new)
Description :  Updates the Virtual Network Gateway.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties to update this gateway with. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteVNETConnections (new)
Description :  Retrieves a list of all Virtual Network Connections associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteVNETConnectionsSlot (new)
Description :  Retrieves a list of all Virtual Network Connections associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections
{
resourceGroupName:
{
Description: The resource group name ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
TopLevelDomains_GetGetTopLevelDomains (new)
Description :  Lists all top level domains supported for registration
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the top level domain ,
Required: False ,
}
string ,
privacy:
{
Description: If true then the top level domain supports domain privacy ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
TopLevelDomains_GetTopLevelDomain (new)
Description :  Gets details of a top level domain
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}
{
name:
{
Description: Name of the top level domain ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the top level domain ,
Required: False ,
}
string ,
privacy:
{
Description: If true then the top level domain supports domain privacy ,
Required: False ,
}
boolean ,
}
,
}
TopLevelDomains_ListTopLevelDomainAgreements (new)
Description :  Lists legal agreements that user needs to accept before purchasing domain
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}/listAgreements
{
name:
{
Description: Name of the top level domain ,
Required: True ,
}
string ,
agreementOption:
{
Description: Domain agreement options ,
Required: True ,
}
{
includePrivacy:
{
Description: If true then the list of agreements will include agreements for domain privacy as well. ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
agreementKey:
{
Description: Unique identifier for the agreement ,
Required: False ,
}
string ,
title:
{
Description: Agreement title ,
Required: False ,
}
string ,
content:
{
Description: Agreement details ,
Required: False ,
}
string ,
url:
{
Description: Url where a copy of the agreement details is hosted ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Usage_GetUsage (new)
Description :  Returns usage records for specified subscription and resource groups
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web.Admin/environments/{environmentName}/usage
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
environmentName:
{
Description: Environment name ,
Required: True ,
}
string ,
lastId:
{
Description: Last marker that was returned from the batch ,
Required: True ,
}
string ,
batchSize:
{
Description: size of the batch to be returned. ,
Format: int32 ,
Required: True ,
}
integer ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
AppServiceCertificateOrders_List (removed)
Description :  List all certificate orders in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/certificateOrders
{
subscriptionId:
{
Description: Your Azure subscription ID. This is 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: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceCertificateOrders_ValidatePurchaseInformation (removed)
Description :  Validate information for a certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation
{
appServiceCertificateOrder:
{
Description: Information for a certificate order. ,
Required: True ,
}
{
properties:
{
Description: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
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)

{}
AppServiceCertificateOrders_ListByResourceGroup (removed)
Description :  Get certificate orders in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders
{
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: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceCertificateOrders_Get (removed)
Description :  Get a certificate order.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_CreateOrUpdate (removed)
Description :  Create or update a certificate purchase order.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
certificateDistinguishedName:
{
Description: Distinguished name to use for the certificate order. ,
Required: True ,
}
{
properties:
{
Description: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
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: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_Delete (removed)
Description :  Delete an existing certificate order.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is 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)

{}
AppServiceCertificateOrders_Update (removed)
Description :  Create or update a certificate purchase order.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
certificateDistinguishedName:
{
Description: Distinguished name to use for the certificate order. ,
Required: True ,
}
{
properties:
{
Description: AppServiceCertificateOrderPatchResource resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
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: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: AppServiceCertificateOrder resource specific properties ,
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret. ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name. ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain verification token. ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3). ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate key size. ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type. ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: True ,
}
enum ,
autoRenew:
{
Description: true if the certificate should be automatically renewed when it expires; otherwise, false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order. ,
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 order status. ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
csr:
{
Description: Last CSR that was created for this order. ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
root:
{
Description: Root certificate. ,
Required: False ,
}
{
version:
{
Description: Certificate Version. ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Certificate Serial Number. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate Subject. ,
Required: False ,
}
string ,
notBefore:
{
Description: Date Certificate is valid from. ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Date Certificate is valid to. ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Certificate Signature algorithm. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate Issuer. ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data. ,
Required: False ,
}
string ,
}
,
serialNumber:
{
Description: Current serial number of the certificate. ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: true if private key is external; otherwise, false. ,
Required: False ,
}
boolean ,
appServiceCertificateNotRenewableReasons:
{
Description: Reasons why App Service Certificate is not renewable at the current moment. ,
Required: False ,
}
[
string ,
]
,
nextAutoRenewalTimeStamp:
{
Description: Time stamp when the certificate would be auto renewed next ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_ListCertificates (removed)
Description :  List all certificates associated with a certificate order.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is 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 ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
AppServiceCertificateOrders_GetCertificate (removed)
Description :  Get the certificate associated with a certificate order.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
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: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
AppServiceCertificateOrders_CreateOrUpdateCertificate (removed)
Description :  Creates or updates a certificate and associates with key vault secret.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
keyVaultCertificate:
{
Description: Key vault certificate resource Id. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-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 ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
AppServiceCertificateOrders_DeleteCertificate (removed)
Description :  Delete the certificate associated with a certificate order.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
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)

{}
AppServiceCertificateOrders_UpdateCertificate (removed)
Description :  Creates or updates a certificate and associates with key vault secret.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
keyVaultCertificate:
{
Description: Key vault certificate resource Id. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-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 ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
}
,
}
AppServiceCertificateOrders_Reissue (removed)
Description :  Reissue an existing certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/reissue
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
reissueCertificateOrderRequest:
{
Description: Parameters for the reissue. ,
Required: True ,
}
{
properties:
{
Description: ReissueCertificateOrderRequest resource specific properties ,
Required: False ,
}
{
keySize:
{
Description: Certificate Key Size. ,
Format: int32 ,
Required: False ,
}
integer ,
delayExistingRevokeInHours:
{
Description: Delay in hours to revoke existing certificate after the new certificate is issued. ,
Format: int32 ,
Required: False ,
}
integer ,
csr:
{
Description: Csr to be used for re-key operation. ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: Should we change the ASC type (from managed private key to external private key and vice versa). ,
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)

{}
AppServiceCertificateOrders_Renew (removed)
Description :  Renew an existing certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/renew
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
renewCertificateOrderRequest:
{
Description: Renew parameters ,
Required: True ,
}
{
properties:
{
Description: RenewCertificateOrderRequest resource specific properties ,
Required: False ,
}
{
keySize:
{
Description: Certificate Key Size. ,
Format: int32 ,
Required: False ,
}
integer ,
csr:
{
Description: Csr to be used for re-key operation. ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: Should we change the ASC type (from managed private key to external private key and vice versa). ,
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)

{}
AppServiceCertificateOrders_ResendEmail (removed)
Description :  Resend certificate email.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/resendEmail
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This 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)

{}
AppServiceCertificateOrders_ResendRequestEmails (removed)
Description :  Verify domain ownership for this certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/resendRequestEmails
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
nameIdentifier:
{
Description: Email address ,
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 (204)

{}
AppServiceCertificateOrders_RetrieveSiteSeal (removed)
Description :  Verify domain ownership for this certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/retrieveSiteSeal
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
siteSealRequest:
{
Description: Site seal request. ,
Required: True ,
}
{
lightTheme:
{
Description: If true use the light color theme for site seal; otherwise, use the default color theme. ,
Required: False ,
}
boolean ,
locale:
{
Description: Locale of site seal. ,
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)

{
html:
{
Description: HTML snippet ,
Required: True ,
}
string ,
}
AppServiceCertificateOrders_VerifyDomainOwnership (removed)
Description :  Verify domain ownership for this certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/verifyDomainOwnership
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This 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)

{}
AppServiceCertificateOrders_RetrieveCertificateActions (removed)
Description :  Retrieve the list of certificate actions.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: CertificateOrderAction resource specific properties ,
Required: False ,
}
{
type:
{
Description: Action type. ,
Enum:
{
CertificateIssued: No description available. ,
CertificateOrderCanceled: No description available. ,
CertificateOrderCreated: No description available. ,
CertificateRevoked: No description available. ,
DomainValidationComplete: No description available. ,
FraudDetected: No description available. ,
OrgNameChange: No description available. ,
OrgValidationComplete: No description available. ,
SanDrop: No description available. ,
FraudCleared: No description available. ,
CertificateExpired: No description available. ,
CertificateExpirationWarning: No description available. ,
FraudDocumentationRequired: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Time at which the certificate action was performed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_RetrieveCertificateEmailHistory (removed)
Description :  Retrieve email history.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: CertificateEmail resource specific properties ,
Required: False ,
}
{
emailId:
{
Description: Email id. ,
Required: False ,
}
string ,
timeStamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateRegistrationProvider_ListOperations (removed)
Description :  Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Required: False ,
}
string ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
CertificateOrders_GetCertificate (removed)
Description :  Get certificate associated with the certificate order
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Certificate name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
CertificateOrders_CreateOrUpdateCertificate (removed)
Description :  Associates a Key Vault secret to a certificate store that will be used for storing the certificate once it's ready
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Certificate name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
keyVaultCertificate:
{
Description: Key Vault secret csm Id ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
CertificateOrders_DeleteCertificate (removed)
Description :  Deletes the certificate associated with the certificate order
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Certificate name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
CertificateOrders_UpdateCertificate (removed)
Description :  Associates a Key Vault secret to a certificate store that will be used for storing the certificate once it's ready
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Certificate name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
keyVaultCertificate:
{
Description: Key Vault secret csm Id ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
CertificateOrders_GetCertificateOrder (removed)
Description :  Get a certificate order
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateOrders_CreateOrUpdateCertificateOrder (removed)
Description :  Create or update a certificate purchase order
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
certificateDistinguishedName:
{
Description: Distinguished name to be used for purchasing certificate ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateOrders_DeleteCertificateOrder (removed)
Description :  Delete an existing certificate order
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
CertificateOrders_UpdateCertificateOrder (removed)
Description :  Create or update a certificate purchase order
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
certificateDistinguishedName:
{
Description: Distinguished name to be used for purchasing certificate ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateOrders_GetCertificateOrders (removed)
Description :  Get certificate orders in a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
CertificateOrders_GetCertificates (removed)
Description :  List all certificates associated with a certificate order (only one certificate can be associated with an order at a time)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Certificate name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault Csm resource Id ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name ,
Required: False ,
}
string ,
provisioningState:
{
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. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
CertificateOrders_ReissueCertificateOrder (removed)
Description :  Reissue an existing certificate order
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/reissue
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
reissueCertificateOrderRequest:
{
Description: Reissue parameters ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
delayExistingRevokeInHours:
{
Description: Delay in hours to revoke existing certificate after the new certificate is issued ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
CertificateOrders_RenewCertificateOrder (removed)
Description :  Renew an existing certificate order
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/renew
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate name ,
Required: True ,
}
string ,
renewCertificateOrderRequest:
{
Description: Renew parameters ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
CertificateOrders_RetrieveCertificateActions (removed)
Description :  Retrieve the list of certificate actions
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveCertificateActions
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate order name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
type:
{
Description: Type ,
Enum:
{
CertificateIssued: No description available. ,
CertificateOrderCanceled: No description available. ,
CertificateOrderCreated: No description available. ,
CertificateRevoked: No description available. ,
DomainValidationComplete: No description available. ,
FraudDetected: No description available. ,
OrgNameChange: No description available. ,
OrgValidationComplete: No description available. ,
SanDrop: No description available. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: Time at which the certificate action was performed ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateOrders_RetrieveCertificateEmailHistory (removed)
Description :  Retrieve email history
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveEmailHistory
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate order name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
emailId:
{
Description: Email id ,
Required: False ,
}
string ,
timeStamp:
{
Description: Time stamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
CertificateOrders_ResendCertificateEmail (removed)
Description :  Resend certificate email
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/resendEmail
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate order name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
CertificateOrders_VerifyDomainOwnership (removed)
Description :  Verify domain ownership for this certificate order
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/verifyDomainOwnership
{
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
name:
{
Description: Certificate order name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Certificates_GetCertificates (removed)
Description :  Get certificates for a subscription in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Certificates_GetCertificate (removed)
Description :  Get a certificate by certificate name for a subscription in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
Certificates_CreateOrUpdateCertificate (removed)
Description :  Creates or modifies an existing certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate if it exists already. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
Certificates_DeleteCertificate (removed)
Description :  Delete a certificate by name in a specified subscription and resourcegroup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate to be deleted. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Certificates_UpdateCertificate (removed)
Description :  Creates or modifies an existing certificate.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate if it exists already. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
Certificates_GetCsrs (removed)
Description :  Gets the certificate signing requests for a subscription in the specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
Certificates_GetCsr (removed)
Description :  Gets a certificate signing request by certificate name for a subscription in the specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
Certificates_CreateOrUpdateCsr (removed)
Description :  Creates or modifies an existing certificate signing request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
csrEnvelope:
{
Description: Details of certificate signing request if it exists already. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
Certificates_DeleteCsr (removed)
Description :  Delete the certificate signing request.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate signing request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Certificates_UpdateCsr (removed)
Description :  Creates or modifies an existing certificate signing request.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
csrEnvelope:
{
Description: Details of certificate signing request if it exists already. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name used to locate CSR object ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished name of certificate to be created ,
Required: False ,
}
string ,
csrString:
{
Description: Actual CSR string created ,
Required: False ,
}
string ,
pfxBlob:
{
Description: PFX certificate of created certificate ,
Required: False ,
}
string ,
password:
{
Description: PFX password ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Hash of the certificates public key ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
}
,
}
ClassicMobileServices_GetClassicMobileServices (removed)
Description :  Get all mobile services in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the mobile service ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ClassicMobileServices_GetClassicMobileService (removed)
Description :  Get a mobile service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of mobile service ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the mobile service ,
Required: False ,
}
string ,
}
,
}
ClassicMobileServices_DeleteClassicMobileService (removed)
Description :  Delete a mobile service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of mobile service ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Domains_GetDomains (removed)
Description :  Lists domains under a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Domains_GetDomain (removed)
Description :  Gets details of a domain
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
Domains_CreateOrUpdateDomain (removed)
Description :  Creates a domain
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: >Name of the resource group ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain ,
Required: True ,
}
string ,
domain:
{
Description: Domain registration information ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
Domains_DeleteDomain (removed)
Description :  Deletes a domain
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain ,
Required: True ,
}
string ,
forceHardDeleteDomain:
{
Description: If true then the domain will be deleted immediately instead of after 24 hours ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
$schema: object ,
}
Domains_UpdateDomain (removed)
Description :  Creates a domain
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: >Name of the resource group ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain ,
Required: True ,
}
string ,
domain:
{
Description: Domain registration information ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
Domains_GetDomainOperation (removed)
Description :  Retrieves the latest status of a domain purchase operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain ,
Required: True ,
}
string ,
operationId:
{
Description: Domain purchase operation Id ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (500)

{}
Global_GetSubscriptionPublishingCredentials (removed)
Description :  Gets publishing credentials for the subscription owner
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/publishingCredentials
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Global_UpdateSubscriptionPublishingCredentials (removed)
Description :  Updates publishing credentials for the subscription owner
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/publishingCredentials
{
requestMessage:
{
Description: requestMessage with new publishing credentials ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Global_GetSubscriptionGeoRegions (removed)
Description :  Gets list of available geo regions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions
{
sku:
{
Description: Filter only to regions that support this sku ,
Required: False ,
}
string ,
linuxWorkersEnabled:
{
Description: Filter only to regions that support linux workers ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Region name ,
Required: False ,
}
string ,
description:
{
Description: Region description ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for region ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllCertificates (removed)
Description :  Get all certificates for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
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 ,
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 ,
password:
{
Description: Certificate password ,
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 ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the certificate ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllServerFarms (removed)
Description :  Gets all App Service Plans for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms
{
detailed:
{
Description: False to return a subset of App Service Plan properties, true to return all of the properties. Retrieval of all properties may increase the API latency. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllSites (removed)
Description :  Gets all Web Apps for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllHostingEnvironments (removed)
Description :  Gets all hostingEnvironments (App Service Environment) for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllManagedHostingEnvironments (removed)
Description :  Gets all managed hosting environments for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/managedHostingEnvironments
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the managed hosting environment ,
Required: False ,
}
string ,
location:
{
Description: Location of the managed hosting environment e.g. "West US" ,
Required: False ,
}
string ,
status:
{
Description: Current status of the managed hosting environment ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
virtualNetwork:
{
Description: Description of the managed hosting environment's virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
ipsslAddressCount:
{
Description: Number of ip ssl addresses reserved for the managed hosting environment ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the managed hosting environment ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription of the managed hosting environment (read only) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the managed hosting environment (read only) ,
Required: False ,
}
string ,
environmentIsHealthy:
{
Description: True/false indicating whether the managed hosting environment is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the managed hosting environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the managed hosting environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
apiManagementAccount:
{
Description: Resource id of the api management account associated with this managed hosting environment (read only) ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_GetAllClassicMobileServices (removed)
Description :  Gets all mobile services for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/classicMobileServices
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the mobile service ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Global_ListPremierAddOnOffers (removed)
Description :  List premier add on offers
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Global_IsHostingEnvironmentNameAvailable (removed)
Description :  Whether hosting environment name is available
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable
{
name:
{
Description: Hosting environment name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Global_IsHostingEnvironmentWithLegacyNameAvailable (removed)
Description :  Whether hosting environment name is available
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable/{name}
{
name:
{
Description: Hosting environment name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Global_CheckNameAvailability (removed)
Description :  Check if 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: False ,
}
string ,
type:
{
Description: Resource type used for verification ,
Required: False ,
}
string ,
isFqdn:
{
Description: Is fully qualified domain name ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Subscription Id ,
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: Required if nameAvailable is false. 'Invalid' indicates the name provided does not match Azure WebApp service’s naming requirements. 'AlreadyExists' indicates that the name is already in use and is therefore unavailable. ,
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
GlobalCertificateOrder_GetAllCertificateOrders (removed)
Description :  Lists all domains in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/certificateOrders
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
GlobalCertificateOrder_ValidateCertificatePurchaseInformation (removed)
Description :  Validate certificate purchase information
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation
{
certificateOrder:
{
Description: Certificate order ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
certificates:
{
Description: State of the Key Vault secret ,
Required: False ,
}
object ,
distinguishedName:
{
Description: Certificate distinguished name ,
Required: False ,
}
string ,
domainVerificationToken:
{
Description: Domain Verification Token ,
Required: False ,
}
string ,
validityInYears:
{
Description: Duration in years (must be between 1 and 3) ,
Format: int32 ,
Required: False ,
}
integer ,
keySize:
{
Description: Certificate Key Size ,
Format: int32 ,
Required: False ,
}
integer ,
productType:
{
Description: Certificate product type ,
Enum:
{
StandardDomainValidatedSsl: No description available. ,
StandardDomainValidatedWildCardSsl: No description available. ,
}
,
Required: False ,
}
enum ,
autoRenew:
{
Description: Auto renew ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Status of certificate order ,
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 order status ,
Enum:
{
Pendingissuance: No description available. ,
Issued: No description available. ,
Revoked: No description available. ,
Canceled: No description available. ,
Denied: No description available. ,
Pendingrevocation: No description available. ,
PendingRekey: No description available. ,
Unused: No description available. ,
Expired: No description available. ,
NotSubmitted: No description available. ,
}
,
Required: False ,
}
enum ,
signedCertificate:
{
Description: Signed certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
csr:
{
Description: Last CSR that was created for this order ,
Required: False ,
}
string ,
intermediate:
{
Description: Intermediate certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
root:
{
Description: Root certificate ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
version:
{
Description: Version ,
Format: int32 ,
Required: False ,
}
integer ,
serialNumber:
{
Description: Serial Number ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint ,
Required: False ,
}
string ,
subject:
{
Description: Subject ,
Required: False ,
}
string ,
notBefore:
{
Description: Valid from ,
Format: date-time ,
Required: False ,
}
string ,
notAfter:
{
Description: Valid to ,
Format: date-time ,
Required: False ,
}
string ,
signatureAlgorithm:
{
Description: Signature Algorithm ,
Required: False ,
}
string ,
issuer:
{
Description: Issuer ,
Required: False ,
}
string ,
rawData:
{
Description: Raw certificate data ,
Required: False ,
}
string ,
}
,
}
,
serialNumber:
{
Description: Current serial number of the certificate ,
Required: False ,
}
string ,
lastCertificateIssuanceTime:
{
Description: Certificate last issuance time ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Certificate expiration time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
GlobalDomainRegistration_GetAllDomains (removed)
Description :  Lists all domains in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
GlobalDomainRegistration_GetDomainControlCenterSsoRequest (removed)
Description :  Generates a single sign on request for domain management portal
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
url:
{
Description: Url where the single sign on request is to be made ,
Required: False ,
}
string ,
postParameterKey:
{
Description: Post parameter key ,
Required: False ,
}
string ,
postParameterValue:
{
Description: Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value. ,
Required: False ,
}
string ,
}
GlobalDomainRegistration_ValidateDomainPurchaseInformation (removed)
Description :  Validates domain registration information
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/validateDomainRegistrationInformation
{
domainRegistrationInput:
{
Description: Domain registration information ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the domain ,
Required: False ,
}
string ,
contactAdmin:
{
Description: Admin contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
contactTech:
{
Description: Technical contact information ,
Required: False ,
}
{
addressMailing:
{
Description: Mailing address ,
Required: False ,
}
{
address1:
{
Description: Address 1 ,
Required: False ,
}
string ,
address2:
{
Description: Address 2 ,
Required: False ,
}
string ,
city:
{
Description: City ,
Required: False ,
}
string ,
country:
{
Description: Country ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code ,
Required: False ,
}
string ,
state:
{
Description: State ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email address ,
Required: False ,
}
string ,
fax:
{
Description: Fax number ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name ,
Required: False ,
}
string ,
nameLast:
{
Description: Last name ,
Required: False ,
}
string ,
nameMiddle:
{
Description: Middle name ,
Required: False ,
}
string ,
organization:
{
Description: Organization ,
Required: False ,
}
string ,
phone:
{
Description: Phone number ,
Required: False ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: If true then domain privacy is enabled for this domain ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: If true then domain will renewed automatically ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname ,
Required: False ,
}
string ,
siteNames:
{
Description: List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the Dns record ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent ,
Required: False ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
GlobalDomainRegistration_CheckDomainAvailability (removed)
Description :  Checks if a domain is available for registration
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability
{
identifier:
{
Description: Name of the domain ,
Required: True ,
}
{
name:
{
Description: Name of the object ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the domain ,
Required: False ,
}
string ,
available:
{
Description: If true then domain can be purchased using CreateDomain Api ,
Required: False ,
}
boolean ,
domainType:
{
Description: Domain type ,
Enum:
{
Regular: No description available. ,
SoftDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
GlobalDomainRegistration_ListDomainRecommendations (removed)
Description :  Lists domain recommendations based on keywords
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations
{
parameters:
{
Description: Domain recommendation search parameters ,
Required: True ,
}
{
keywords:
{
Description: Keywords to be used for generating domain recommendations ,
Required: False ,
}
string ,
maxDomainRecommendations:
{
Description: Maximum number of recommendations ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the object ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
GlobalResourceGroups_MoveResources (removed)
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources
{
resourceGroupName:
{
Required: True ,
}
string ,
moveResourceEnvelope:
{
Required: True ,
}
{
targetResourceGroup:
{
Required: False ,
}
string ,
resources:
{
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
HostingEnvironments_GetHostingEnvironment (removed)
Description :  Get properties of hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
HostingEnvironments_CreateOrUpdateHostingEnvironment (removed)
Description :  Create or update a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
hostingEnvironmentEnvelope:
{
Description: Properties of hostingEnvironment (App Service Environment) ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
HostingEnvironments_DeleteHostingEnvironment (removed)
Description :  Delete a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
forceDelete:
{
Description: Delete even if the hostingEnvironment (App Service Environment) contains resources ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
HostingEnvironments_GetHostingEnvironmentDiagnostics (removed)
Description :  Get diagnostic information for hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name/identifier of the diagnostics ,
Required: False ,
}
string ,
diagnosicsOutput:
{
Description: Diagnostics output ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentDiagnosticsItem (removed)
Description :  Get diagnostic information for hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
diagnosticsName:
{
Description: Name of the diagnostics ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name/identifier of the diagnostics ,
Required: False ,
}
string ,
diagnosicsOutput:
{
Description: Diagnostics output ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentCapacities (removed)
Description :  Get used, available, and total worker capacity for hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentVips (removed)
Description :  Get IP addresses assigned to the hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceIpAddress:
{
Description: Main public vip ,
Required: False ,
}
string ,
internalIpAddress:
{
Description: VNET internal ip address of the hostingEnvironment (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 vips ,
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 VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
}
HostingEnvironments_GetHostingEnvironments (removed)
Description :  Get all hostingEnvironments (App Service Environments) in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_RebootHostingEnvironment (removed)
Description :  Reboots all machines in a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
HostingEnvironments_GetHostingEnvironmentOperations (removed)
Description :  List all currently running operations on the hostingEnvironment (App Service Environment)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
HostingEnvironments_GetHostingEnvironmentOperation (removed)
Description :  Get status of an operation on a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
operationId:
{
Description: operation identifier GUID ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (404)

{}

⚐ Response (500)

{}
HostingEnvironments_GetHostingEnvironmentMetrics (removed)
Description :  Get global metrics of hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
details:
{
Description: Include instance details ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of metric ,
Required: False ,
}
{
value:
{
Description: metric name value ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values ,
Required: False ,
}
[
{
timeStamp:
{
Description: Value timestamp ,
Required: False ,
}
string ,
average:
{
Description: Value average ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
properties:
{
Description: Properties ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentMetricDefinitions (removed)
Description :  Get global metric definitions of hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
HostingEnvironments_GetHostingEnvironmentUsages (removed)
Description :  Get global usages of hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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 ,
}
HostingEnvironments_GetHostingEnvironmentMultiRoleMetrics (removed)
Description :  Get metrics for a multiRole pool of a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
startTime:
{
Description: Beginning time of metrics query ,
Required: False ,
}
string ,
endTime:
{
Description: End time of metrics query ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time granularity of metrics query ,
Required: False ,
}
string ,
details:
{
Description: Include instance details ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
details:
{
Description: Include instance details ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentWebWorkerMetricDefinitions (removed)
Description :  Get metric definitions for a worker pool of a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentMultiRoleUsages (removed)
Description :  Get usages for a multiRole pool of a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Comma separated list of site properties to include ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentWebHostingPlans (removed)
Description :  Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/webhostingplans
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetHostingEnvironmentServerFarms (removed)
Description :  Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetMultiRolePools (removed)
Description :  Get all multi role pools
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetMultiRolePool (removed)
Description :  Get properties of a multiRole pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
HostingEnvironments_CreateOrUpdateMultiRolePool (removed)
Description :  Create or update a multiRole pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
multiRolePoolEnvelope:
{
Description: Properties of multiRole pool ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
HostingEnvironments_GetMultiRolePoolSkus (removed)
Description :  Get available skus for scaling a multiRole pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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 ,
}
,
capacity:
{
Description: Min, max, and default scale values of the sku ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service Plan ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetWorkerPools (removed)
Description :  Get all worker pools
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetWorkerPool (removed)
Description :  Get properties of a worker pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
HostingEnvironments_CreateOrUpdateWorkerPool (removed)
Description :  Create or update a worker pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
workerPoolEnvelope:
{
Description: Properties of worker pool ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
HostingEnvironments_GetWorkerPoolSkus (removed)
Description :  Get available skus for scaling a worker pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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 ,
}
,
capacity:
{
Description: Min, max, and default scale values of the sku ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of Workers for this App Service Plan SKU ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service Plan ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_GetWorkerPoolInstanceMetrics (removed)
Description :  Get metrics for a specific instance of a worker pool of a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
instance:
{
Description: Name of instance in the worker pool ,
Required: True ,
}
string ,
details:
{
Description: Include instance details ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
HostingEnvironments_GetWorkerPoolInstanceMetricDefinitions (removed)
Description :  Get metric definitions for a specific instance of a worker pool of a hostingEnvironment (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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
workerPoolName:
{
Description: Name of worker pool ,
Required: True ,
}
string ,
instance:
{
Description: Name of instance in the worker pool ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
HostingEnvironments_GetMultiRolePoolInstanceMetrics (removed)
Description :  Get metrics for a specific instance of a multiRole pool of a hostingEnvironment (App Service Environment).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
instance:
{
Description: Name of instance in the multiRole pool ,
Required: True ,
}
string ,
details:
{
Description: Include instance details ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
HostingEnvironments_GetMultiRolePoolInstanceMetricDefinitions (removed)
Description :  Get metric definitions for a specific instance of a multiRole pool of a hostingEnvironment (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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
instance:
{
Description: Name of instance in the multiRole pool> ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
HostingEnvironments_SuspendHostingEnvironment (removed)
Description :  Suspends the hostingEnvironment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
HostingEnvironments_ResumeHostingEnvironment (removed)
Description :  Resumes the hostingEnvironment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of hostingEnvironment (App Service Environment) ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedHostingEnvironments_GetManagedHostingEnvironment (removed)
Description :  Get properties of a managed hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the managed hosting environment ,
Required: False ,
}
string ,
location:
{
Description: Location of the managed hosting environment e.g. "West US" ,
Required: False ,
}
string ,
status:
{
Description: Current status of the managed hosting environment ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
virtualNetwork:
{
Description: Description of the managed hosting environment's virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
ipsslAddressCount:
{
Description: Number of ip ssl addresses reserved for the managed hosting environment ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSuffix:
{
Description: DNS suffix of the managed hosting environment ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription of the managed hosting environment (read only) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the managed hosting environment (read only) ,
Required: False ,
}
string ,
environmentIsHealthy:
{
Description: True/false indicating whether the managed hosting environment is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the managed hosting environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the managed hosting environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
apiManagementAccount:
{
Description: Resource id of the api management account associated with this managed hosting environment (read only) ,
Required: False ,
}
string ,
}
,
}
ManagedHostingEnvironments_CreateOrUpdateManagedHostingEnvironment (removed)
Description :  Create or update a managed hosting environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
ManagedHostingEnvironmentEnvelope:
{
Description: Properties of managed hosting environment ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
ManagedHostingEnvironments_DeleteManagedHostingEnvironment (removed)
Description :  Delete a managed hosting environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
forceDelete:
{
Description: Delete even if the managed hosting environment contains resources ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (400)

{}

⚐ Response (404)

{}

⚐ Response (409)

{}
ManagedHostingEnvironments_GetManagedHostingEnvironments (removed)
Description :  Get all managed hosting environments in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
location:
{
Description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hostingEnvironment (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 hostingEnvironment (App Service Environment) ,
Enum:
{
Preparing: No description available. ,
Ready: No description available. ,
Scaling: No description available. ,
Deleting: No description available. ,
}
,
Required: True ,
}
enum ,
vnetName:
{
Description: Name of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetResourceGroupName:
{
Description: Resource group of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: Subnet of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
string ,
virtualNetwork:
{
Description: Description of the hostingEnvironment's (App Service Environment) virtual network ,
Required: False ,
}
{
id:
{
Description: Resource id of the virtual network ,
Required: False ,
}
string ,
name:
{
Description: Name of the virtual network (read-only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the virtual network (read-only) ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet within the virtual network ,
Required: False ,
}
string ,
}
,
internalLoadBalancingMode:
{
Description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET ,
Enum:
{
None: No description available. ,
Web: No description available. ,
Publishing: No description available. ,
}
,
Required: False ,
}
enum ,
multiSize:
{
Description: Front-end VM size, e.g. "Medium", "Large" ,
Required: False ,
}
string ,
multiRoleCount:
{
Description: Number of front-end instances ,
Format: int32 ,
Required: False ,
}
integer ,
workerPools:
{
Description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
workerSizeId:
{
Description: Worker size id for referencing this worker pool ,
Format: int32 ,
Required: False ,
}
integer ,
computeMode:
{
Description: Shared or dedicated web 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: Describes 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 ,
}
,
}
,
]
,
ipsslAddressCount:
{
Description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
databaseEdition:
{
Description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" ,
Required: False ,
}
string ,
databaseServiceObjective:
{
Description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" ,
Required: False ,
}
string ,
upgradeDomains:
{
Description: Number of upgrade domains of this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: DNS suffix of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastAction:
{
Description: Last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
lastActionResult:
{
Description: Result of the last deployment action on this hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
allowedMultiSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for front-ends ,
Required: False ,
}
string ,
allowedWorkerSizes:
{
Description: List of comma separated strings describing which VM sizes are allowed for workers ,
Required: False ,
}
string ,
maximumNumberOfMachines:
{
Description: Maximum number of VMs in this hostingEnvironment (App Service Environment) ,
Format: int32 ,
Required: False ,
}
integer ,
vipMappings:
{
Description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
virtualIP:
{
Description: Virtual IP address ,
Required: False ,
}
string ,
internalHttpPort:
{
Description: Internal HTTP port ,
Format: int32 ,
Required: False ,
}
integer ,
internalHttpsPort:
{
Description: Internal HTTPS port ,
Format: int32 ,
Required: False ,
}
integer ,
inUse:
{
Description: Is VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
environmentCapacities:
{
Description: Current total, used, and available worker capacities ,
Required: False ,
}
[
{
name:
{
Description: Name of the stamp ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Available capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
totalCapacity:
{
Description: Total capacity (# of machines, bytes of storage etc...) ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Name of the unit ,
Required: False ,
}
string ,
computeMode:
{
Description: Shared/Dedicated workers ,
Enum:
{
Shared: No description available. ,
Dedicated: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
workerSize:
{
Description: Size of the machines ,
Enum:
{
Default: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
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 sites Basic sites are not used for capacity allocation. ,
Required: False ,
}
boolean ,
isApplicableForAllComputeModes:
{
Description: Is capacity applicable for all sites? ,
Required: False ,
}
boolean ,
siteMode:
{
Description: Shared or Dedicated ,
Required: False ,
}
string ,
}
,
]
,
networkAccessControlList:
{
Description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) ,
Required: False ,
}
[
{
action:
{
Enum:
{
Permit: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
remoteSubnet:
{
Required: False ,
}
string ,
}
,
]
,
environmentIsHealthy:
{
Description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy ,
Required: False ,
}
boolean ,
environmentStatus:
{
Description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
apiManagementAccountId:
{
Description: Api Management Account associated with this Hosting Environment ,
Required: False ,
}
string ,
suspended:
{
Description: True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic) ,
Required: False ,
}
boolean ,
clusterSettings:
{
Description: Custom settings for changing the behavior of the hosting environment ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedHostingEnvironments_GetManagedHostingEnvironmentVips (removed)
Description :  Get list of ip addresses assigned to a managed hosting environment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/capacities/virtualip
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceIpAddress:
{
Description: Main public vip ,
Required: False ,
}
string ,
internalIpAddress:
{
Description: VNET internal ip address of the hostingEnvironment (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 vips ,
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 VIP mapping in use ,
Required: False ,
}
boolean ,
}
,
]
,
}
ManagedHostingEnvironments_GetManagedHostingEnvironmentOperation (removed)
Description :  Get status of an operation on a managed hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/operations/{operationId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
operationId:
{
Description: operation identifier GUID ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (404)

{}

⚐ Response (500)

{}
ManagedHostingEnvironments_GetManagedHostingEnvironmentSites (removed)
Description :  Get all sites on the managed hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/sites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Comma separated list of site properties to include ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedHostingEnvironments_GetManagedHostingEnvironmentWebHostingPlans (removed)
Description :  Get all serverfarms (App Service Plans) on the managed hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/webhostingplans
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedHostingEnvironments_GetManagedHostingEnvironmentServerFarms (removed)
Description :  Get all serverfarms (App Service Plans) on the managed hosting environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/serverfarms
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of managed hosting environment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Provider_GetSourceControls (removed)
Description :  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: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name or Source Control Type ,
Required: False ,
}
string ,
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 ,
}
Provider_GetSourceControl (removed)
Description :  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:
{
Required: False ,
}
{
name:
{
Description: Name or Source Control Type ,
Required: False ,
}
string ,
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 ,
}
,
}
Provider_UpdateSourceControl (removed)
Description :  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:
{
Required: False ,
}
{
name:
{
Description: Name or Source Control Type ,
Required: False ,
}
string ,
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:
{
Required: False ,
}
{
name:
{
Description: Name or Source Control Type ,
Required: False ,
}
string ,
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 ,
}
,
}
Provider_GetPublishingUser (removed)
Description :  Gets publishing user
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Provider_UpdatePublishingUser (removed)
Description :  Updates publishing user
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Web/publishingUsers/web
{
requestMessage:
{
Description: Details of publishing user ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Recommendations_GetRecommendationBySubscription (removed)
Description :  Gets a list of recommendations associated with the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations
{
featured:
{
Description: If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification' ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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. ,
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. ,
Required: False ,
}
string ,
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: Localized text of recommendation, good for UI. ,
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: True ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
All: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
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: On/off flag indicating the rule is currently enabled or disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The beginning time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp 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 ,
}
Recommendations_GetRuleDetailsBySiteName (removed)
Description :  Gets the detailed properties of the recommendation object for the specified web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}
{
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
name:
{
Description: Recommendation rule name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
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. ,
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 ,
enabled:
{
Description: On/off flag indicating the rule is currently enabled or disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
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: True ,
}
enum ,
channels:
{
Description: List of available channels that this rule applies. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
All: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
Description: An array of category tags that the rule contains. ,
Required: False ,
}
[
string ,
]
,
}
Recommendations_GetRecommendedRulesForSite (removed)
Description :  Gets a list of recommendations associated with the specified web site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations
{
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
featured:
{
Description: If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available ,
Required: False ,
}
boolean ,
siteSku:
{
Description: The name of site SKU. ,
Required: False ,
}
string ,
numSlots:
{
Description: The number of site slots associated to the site ,
Format: int32 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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. ,
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. ,
Required: False ,
}
string ,
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: Localized text of recommendation, good for UI. ,
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: True ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
All: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
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: On/off flag indicating the rule is currently enabled or disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The beginning time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp 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 ,
}
Recommendations_GetRecommendationHistoryForSite (removed)
Description :  Gets the list of past recommendations optionally specified by the time range.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory
{
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of a time range to query, e.g. $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq '2015-01-02T00:00:00Z' ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of a time range to query, e.g. $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq '2015-01-02T00:00:00Z' ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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. ,
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. ,
Required: False ,
}
string ,
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: Localized text of recommendation, good for UI. ,
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: True ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
All: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
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: On/off flag indicating the rule is currently enabled or disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The beginning time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp 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 ,
}
ServerFarms_GetServerFarms (removed)
Description :  Gets collection of App Service Plans in a resource group for a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ServerFarms_GetServerFarm (removed)
Description :  Gets specified App Service Plan in a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
ServerFarms_CreateOrUpdateServerFarm (removed)
Description :  Creates or updates an App Service Plan
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
serverFarmEnvelope:
{
Description: Details of App Service Plan ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
,
allowPendingState:
{
Description: OBSOLETE: If true, allow pending state for App Service Plan ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
ServerFarms_DeleteServerFarm (removed)
Description :  Deletes a App Service Plan
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
ServerFarms_GetServerFarmMetrics (removed)
Description :  Queries for App Service Plan metrics
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
details:
{
Description: If true, metrics are broken down per App Service Plan instance ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of metric ,
Required: False ,
}
{
value:
{
Description: metric name value ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values ,
Required: False ,
}
[
{
timeStamp:
{
Description: Value timestamp ,
Required: False ,
}
string ,
average:
{
Description: Value average ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
properties:
{
Description: Properties ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ServerFarms_GetServerFarmMetricDefintions (removed)
Description :  List of metrics that can be queried for an App Service Plan
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ServerFarms_GetVnetsForServerFarm (removed)
Description :  Gets list of VNets associated with App Service Plan
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
ServerFarms_GetVnetFromServerFarm (removed)
Description :  Gets a vnet 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
ServerFarms_GetRoutesForVnet (removed)
Description :  Gets a list of all routes associated with a vnet, 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
ServerFarms_GetRouteForVnet (removed)
Description :  Gets a specific route associated with a vnet, 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the virtual network route ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
ServerFarms_CreateOrUpdateVnetRoute (removed)
Description :  Creates a new route or updates an existing route for a vnet 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the virtual network route ,
Required: True ,
}
string ,
route:
{
Description: The route object ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}
ServerFarms_DeleteVnetRoute (removed)
Description :  Deletes an existing route for a vnet 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the virtual network route ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (404)

{}
ServerFarms_UpdateVnetRoute (removed)
Description :  Creates a new route or updates an existing route for a vnet 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: Name of virtual network ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the virtual network route ,
Required: True ,
}
string ,
route:
{
Description: The route object ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (400)

{}

⚐ Response (404)

{}
ServerFarms_GetServerFarmVnetGateway (removed)
Description :  Gets the vnet gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
ServerFarms_UpdateServerFarmVnetGateway (removed)
Description :  Updates the vnet gateway
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
name:
{
Description: The name of the App Service Plan ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the virtual network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. Only 'primary' is supported. ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The gateway entity. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
ServerFarms_GetServerFarmSites (removed)
Description :  Gets list of 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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
$skipToken:
{
Description: Skip to of web apps in a list. If specified, the resulting list will contain web apps starting from (including) the skipToken. Else, the resulting list contains web apps from the start of the list ,
Required: False ,
}
string ,
$filter:
{
Description: Supported filter: $filter=state eq running. Returns only web apps that are currently running ,
Required: False ,
}
string ,
$top:
{
Description: List page size. If specified, results are paged. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ServerFarms_RebootWorkerForServerFarm (removed)
Description :  Submit a reboot request for a worker machine in the specified server farm
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of server farm ,
Required: True ,
}
string ,
workerName:
{
Description: Name of worker machine, typically starts with RD ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
ServerFarms_RestartSitesForServerFarm (removed)
Description :  Restarts web apps in a specified App Service Plan
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of App Service Plan ,
Required: True ,
}
string ,
softRestart:
{
Description: Soft restart applies the configuration settings and restarts the apps if necessary. Hard restart always restarts and reprovisions the apps ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
ServerFarms_GetServerFarmOperation (removed)
Description :  Gets a server farm operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of server farm ,
Required: True ,
}
string ,
operationId:
{
Description: Id of Server farm operation"> ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name for the App Service Plan ,
Required: False ,
}
string ,
workerTierName:
{
Description: Target worker tier assigned to the App Service Plan ,
Required: False ,
}
string ,
status:
{
Description: App Service Plan Status ,
Enum:
{
Ready: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
subscription:
{
Description: App Service Plan Subscription ,
Required: False ,
}
string ,
adminSiteName:
{
Description: App Service Plan administration site ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
maximumNumberOfWorkers:
{
Description: Maximum number of instances that can be assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
geoRegion:
{
Description: Geographical location for the App Service Plan ,
Required: False ,
}
string ,
perSiteScaling:
{
Description: If True apps assigned to this App Service Plan can be scaled independently If False apps assigned to this App Service Plan will scale to all instances of the plan ,
Required: False ,
}
boolean ,
numberOfSites:
{
Description: Number of web apps assigned to this App Service Plan ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGroup:
{
Description: Resource group of the server farm ,
Required: False ,
}
string ,
reserved:
{
Description: Enables creation of a Linux App Service Plan ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Describes 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 ,
}
,
}
Sites_GetSiteVNETConnectionSlot (removed)
Description :  Retrieves a specific Virtual Network Connection associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_CreateOrUpdateSiteVNETConnectionSlot (removed)
Description :  Adds a Virtual Network Connection or updates it's properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties of this Virtual Network Connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteSiteVNETConnectionSlot (removed)
Description :  Removes the specified Virtual Network Connection association from this web app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteVNETConnectionSlot (removed)
Description :  Adds a Virtual Network Connection or updates it's properties.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties of this Virtual Network Connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteVNETConnection (removed)
Description :  Retrieves a specific Virtual Network Connection associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_CreateOrUpdateSiteVNETConnection (removed)
Description :  Adds a Virtual Network Connection or updates it's properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties of this Virtual Network Connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteSiteVNETConnection (removed)
Description :  Removes the specified Virtual Network Connection association from this web app.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteVNETConnection (removed)
Description :  Adds a Virtual Network Connection or updates it's properties.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties of this Virtual Network Connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteNetworkFeaturesSlot (removed)
Description :  Retrieves a view of all network features in use on this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
view:
{
Description: The type of view. This can either be "summary" or "detailed". ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
virtualNetworkName:
{
Description: The Vnet Name ,
Required: False ,
}
string ,
virtualNetworkConnection:
{
Description: The Vnet Summary view ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
hybridConnections:
{
Description: The Hybrid Connections Summary view ,
Required: False ,
}
[
{
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 (404)

{}
Sites_GetSiteNetworkFeatures (removed)
Description :  Retrieves a view of all network features in use on this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
view:
{
Description: The type of view. This can either be "summary" or "detailed". ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
virtualNetworkName:
{
Description: The Vnet Name ,
Required: False ,
}
string ,
virtualNetworkConnection:
{
Description: The Vnet Summary view ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
hybridConnections:
{
Description: The Hybrid Connections Summary view ,
Required: False ,
}
[
{
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 (404)

{}
Sites_GetSiteOperationSlot (removed)
Description :  Gets the operation for a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
operationId:
{
Description: Id of an operation ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteOperation (removed)
Description :  Gets the operation for a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/operationresults/{operationId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
operationId:
{
Description: Id of an operation ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_SwapSlotWithProduction (removed)
Description :  Swaps web app slots
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
$schema: object ,
}
Sites_SwapSlotsSlot (removed)
Description :  Swaps web app slots
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
slot:
{
Description: Name of source slot for the swap ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
$schema: object ,
}
Sites_GetSlotsDifferencesFromProduction (removed)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
type:
{
Description: Indicates the type of the difference: Information, Warning or Error. ,
Required: False ,
}
string ,
settingType:
{
Description: The type of the settings: General, AppSetting or ConnectionString ,
Required: False ,
}
string ,
diffRule:
{
Description: Rule that describes how to process the difference in settings during web app slot swap. ,
Required: False ,
}
string ,
settingName:
{
Description: Name of the setting ,
Required: False ,
}
string ,
valueInCurrentSlot:
{
Description: Value of the setting in the current web app slot ,
Required: False ,
}
string ,
valueInTargetSlot:
{
Description: Value of the setting in the target web app slot ,
Required: False ,
}
string ,
description:
{
Description: Description of the difference ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSlotsDifferencesSlot (removed)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
slot:
{
Description: Name of the source slot ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
type:
{
Description: Indicates the type of the difference: Information, Warning or Error. ,
Required: False ,
}
string ,
settingType:
{
Description: The type of the settings: General, AppSetting or ConnectionString ,
Required: False ,
}
string ,
diffRule:
{
Description: Rule that describes how to process the difference in settings during web app slot swap. ,
Required: False ,
}
string ,
settingName:
{
Description: Name of the setting ,
Required: False ,
}
string ,
valueInCurrentSlot:
{
Description: Value of the setting in the current web app slot ,
Required: False ,
}
string ,
valueInTargetSlot:
{
Description: Value of the setting in the target web app slot ,
Required: False ,
}
string ,
description:
{
Description: Description of the difference ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_ApplySlotConfigToProduction (removed)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name. Settings from that slot will be applied on the source slot ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_ApplySlotConfigSlot (removed)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotSwapEntity:
{
Description: Request body that contains the target slot name. Settings from that slot will be applied on the source slot ,
Required: True ,
}
{
targetSlot:
{
Description: Set the destination deployment slot during swap operation ,
Required: False ,
}
string ,
preserveVnet:
{
Description: Get or set the flag indicating it should preserve VNet to the slot during swap ,
Required: False ,
}
boolean ,
}
,
slot:
{
Description: Name of the source slot. Settings from the target slot will be applied onto this slot ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_ResetProductionSlotConfig (removed)
Description :  Resets the configuration settings of the current slot if they were previously modified by calling ApplySlotConfig API
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_ResetSlotConfigSlot (removed)
Description :  Resets the configuration settings of the current slot if they were previously modified by calling ApplySlotConfig API
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSlotConfigNames (removed)
Description :  Gets the names of application settings and connection string that remain with the slot during swap operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionStringNames:
{
Description: List of connection string names ,
Required: False ,
}
[
string ,
]
,
appSettingNames:
{
Description: List of application settings names ,
Required: False ,
}
[
string ,
]
,
}
,
}
Sites_UpdateSlotConfigNames (removed)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
slotConfigNames:
{
Description: Request body containing the names of application settings and connection strings ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
connectionStringNames:
{
Description: List of connection string names ,
Required: False ,
}
[
string ,
]
,
appSettingNames:
{
Description: List of application settings names ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionStringNames:
{
Description: List of connection string names ,
Required: False ,
}
[
string ,
]
,
appSettingNames:
{
Description: List of application settings names ,
Required: False ,
}
[
string ,
]
,
}
,
}
Sites_GetSiteSlots (removed)
Description :  Gets all the slots for a web apps
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: List of app properties to include in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSites (removed)
Description :  Gets the web apps for a subscription in the specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
includeSiteTypes:
{
Description: Types of apps included in the response ,
Required: False ,
}
string ,
includeSlots:
{
Description: Whether or not to include deployments slots in results ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSite (removed)
Description :  Get details of a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_CreateOrUpdateSite (removed)
Description :  Creates a new web app or modifies an existing web app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the web app ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: Details of web app if it exists already ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
skipDnsRegistration:
{
Description: If true web app hostname is not registered with DNS on creation. This parameter is only used for app creation ,
Required: False ,
}
string ,
skipCustomDomainVerification:
{
Description: If true, custom (non *.azurewebsites.net) domains associated with web app are not verified. ,
Required: False ,
}
string ,
forceDnsRegistration:
{
Description: If true, web app hostname is force registered with DNS ,
Required: False ,
}
string ,
ttlInSeconds:
{
Description: Time to live in seconds for web app's default domain name ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteSite (removed)
Description :  Deletes a web app
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
deleteMetrics:
{
Description: If true, web app metrics are also deleted ,
Required: False ,
}
string ,
deleteEmptyServerFarm:
{
Description: If true and App Service Plan is empty after web app deletion, App Service Plan is also deleted ,
Required: False ,
}
string ,
skipDnsRegistration:
{
Description: If true, DNS registration is skipped ,
Required: False ,
}
string ,
deleteAllSlots:
{
Description: If true, all slots associated with web app are also deleted ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteSlot (removed)
Description :  Get details of a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of resource group ,
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 ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_CreateOrUpdateSiteSlot (removed)
Description :  Creates a new web app or modifies an existing web app.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the web app ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: Details of web app if it exists already ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
skipDnsRegistration:
{
Description: If true web app hostname is not registered with DNS on creation. This parameter is only used for app creation ,
Required: False ,
}
string ,
skipCustomDomainVerification:
{
Description: If true, custom (non *.azurewebsites.net) domains associated with web app are not verified. ,
Required: False ,
}
string ,
forceDnsRegistration:
{
Description: If true, web app hostname is force registered with DNS ,
Required: False ,
}
string ,
ttlInSeconds:
{
Description: Time to live in seconds for web app's default domain name ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteSiteSlot (removed)
Description :  Deletes a web app
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of resource group ,
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 ,
deleteMetrics:
{
Description: If true, web app metrics are also deleted ,
Required: False ,
}
string ,
deleteEmptyServerFarm:
{
Description: If true and App Service Plan is empty after web app deletion, App Service Plan is also deleted ,
Required: False ,
}
string ,
skipDnsRegistration:
{
Description: If true, DNS registration is skipped ,
Required: False ,
}
string ,
deleteAllSlots:
{
Description: If true, all slots associated with web app are also deleted ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_IsSiteCloneable (removed)
Description :  Creates a new web app or modifies an existing web app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
result:
{
Description: Name of web app ,
Enum:
{
Cloneable: No description available. ,
PartiallyCloneable: No description available. ,
NotCloneable: No description available. ,
}
,
Required: True ,
}
enum ,
blockingFeatures:
{
Description: List of features enabled on web 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 web app that are non-blocking but cannot be cloned. The web app can still be cloned but the features in this list will not be set up on cloned web 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 ,
}
,
]
,
}
Sites_IsSiteCloneableSlot (removed)
Description :  Creates a new web app or modifies an existing web app.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable
{
resourceGroupName:
{
Description: Name of the resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of the 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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
result:
{
Description: Name of web app ,
Enum:
{
Cloneable: No description available. ,
PartiallyCloneable: No description available. ,
NotCloneable: No description available. ,
}
,
Required: True ,
}
enum ,
blockingFeatures:
{
Description: List of features enabled on web 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 web app that are non-blocking but cannot be cloned. The web app can still be cloned but the features in this list will not be set up on cloned web 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 ,
}
,
]
,
}
Sites_RecoverSite (removed)
Description :  Recovers a deleted web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
recoveryEntity:
{
Description: Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. ,
Required: True ,
}
{
snapshotTime:
{
Description: Point in time in which the site recover should be attempted. ,
Format: date-time ,
Required: False ,
}
string ,
recoverConfig:
{
Description: If true, then the website's configuration will be reverted to its state at SnapshotTime ,
Required: False ,
}
boolean ,
siteName:
{
Description: [Optional] Destination web app name into which web app should be recovered. This is case when new web app should be created instead. ,
Required: False ,
}
string ,
slotName:
{
Description: [Optional] Destination web app slot name into which web app should be recovered ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
Sites_RecoverSiteSlot (removed)
Description :  Recovers a deleted web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
recoveryEntity:
{
Description: Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. ,
Required: True ,
}
{
snapshotTime:
{
Description: Point in time in which the site recover should be attempted. ,
Format: date-time ,
Required: False ,
}
string ,
recoverConfig:
{
Description: If true, then the website's configuration will be reverted to its state at SnapshotTime ,
Required: False ,
}
boolean ,
siteName:
{
Description: [Optional] Destination web app name into which web app should be recovered. This is case when new web app should be created instead. ,
Required: False ,
}
string ,
slotName:
{
Description: [Optional] Destination web app slot name into which web app should be recovered ,
Required: False ,
}
string ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}
Sites_GetSiteSnapshots (removed)
Description :  Returns all Snapshots to the user.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots
{
resourceGroupName:
{
Description: Webspace ,
Required: True ,
}
string ,
name:
{
Description: Website Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteSnapshotsSlot (removed)
Description :  Returns all Snapshots to the user.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots
{
resourceGroupName:
{
Description: Webspace ,
Required: True ,
}
string ,
name:
{
Description: Website Name ,
Required: True ,
}
string ,
slot:
{
Description: Website Slot ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetDeletedSites (removed)
Description :  Gets deleted web apps in subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/deletedSites
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
propertiesToInclude:
{
Description: Additional web app properties included in the response ,
Required: False ,
}
string ,
includeSiteTypes:
{
Description: Types of apps included in the response ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
deletedTimestamp:
{
Description: Time when the site was deleted ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of web app ,
Required: False ,
}
string ,
state:
{
Description: State of the web app ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of repository site ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether web app has exceeded its quota usage ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: True ,
}
enum ,
enabled:
{
Description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: True ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Host name ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: True ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the host name if IP based SSL is enabled ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL cert thumbprint ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set this flag to update existing host name ,
Required: False ,
}
boolean ,
}
,
]
,
serverFarmId:
{
Required: False ,
}
string ,
lastModifiedTimeUtc:
{
Description: Last time web app was modified in UTC ,
Format: date-time ,
Required: False ,
}
string ,
siteConfig:
{
Description: Configuration of web app ,
Required: False ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
trafficManagerHostNames:
{
Description: Read-only list of Azure Traffic manager hostnames associated with web app ,
Required: False ,
}
[
string ,
]
,
premiumAppDeployed:
{
Description: If set indicates whether web app is deployed as a premium app ,
Required: False ,
}
boolean ,
scmSiteAlsoStopped:
{
Description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Read-only property that specifies which slot this app will swap into ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the hosting environment (App Service Environment) to use for the web app ,
Required: False ,
}
{
id:
{
Description: Resource id of the hostingEnvironment (App Service Environment) ,
Required: False ,
}
string ,
name:
{
Description: Name of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the hostingEnvironment (App Service Environment) (read only) ,
Required: False ,
}
string ,
}
,
microService:
{
Required: False ,
}
string ,
gatewaySiteName:
{
Description: Name of gateway app associated with web app ,
Required: False ,
}
string ,
clientAffinityEnabled:
{
Description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: Specifies if the client certificate is enabled for the web app ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: Specifies if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process ,
Required: False ,
}
boolean ,
outboundIpAddresses:
{
Description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of a function container ,
Format: int32 ,
Required: False ,
}
integer ,
maxNumberOfWorkers:
{
Description: Maximum number of workers This only applies to function container ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: This is only valid for web app creation. If specified, web app is cloned from a source web app ,
Required: False ,
}
{
correlationId:
{
Description: Correlation Id of cloning operation. This id ties multiple cloning operations together to use the same snapshot ,
Required: False ,
}
string ,
overwrite:
{
Description: Overwrite destination web app ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: If true, clone custom hostnames from source web app ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: Clone source control from source web app ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource id of the source web app. Web 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: False ,
}
string ,
hostingEnvironment:
{
Description: Hosting environment ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application settings overrides for cloned web app. If specified these settings will override the settings cloned from source web app. If not specified, application settings from source web app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: If specified configure load balancing for source and clone site ,
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: Resource group web app belongs to ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: Site is a default container ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the web app ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetDeployments (removed)
Description :  List deployments
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetDeploymentsSlot (removed)
Description :  List deployments
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetInstanceDeployments (removed)
Description :  List deployments
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
instanceId:
{
Description: Id of web app instance ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetInstanceDeploymentsSlot (removed)
Description :  List deployments
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetInstanceDeployment (removed)
Description :  Get the deployment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
instanceId:
{
Description: Id of web app instance ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_CreateInstanceDeployment (removed)
Description :  Create a deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
instanceId:
{
Description: Id of web app instance ,
Required: True ,
}
string ,
deployment:
{
Description: Details of deployment ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteInstanceDeployment (removed)
Description :  Delete the deployment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
instanceId:
{
Description: Id of web app instance ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetDeployment (removed)
Description :  Get the deployment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_CreateDeployment (removed)
Description :  Create a deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
deployment:
{
Description: Details of deployment ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteDeployment (removed)
Description :  Delete the deployment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetDeploymentSlot (removed)
Description :  Get the deployment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_CreateDeploymentSlot (removed)
Description :  Create a deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
deployment:
{
Description: Details of deployment ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteDeploymentSlot (removed)
Description :  Delete the deployment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetInstanceDeploymentSlot (removed)
Description :  Get the deployment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_CreateInstanceDeploymentSlot (removed)
Description :  Create a deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
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 ,
deployment:
{
Description: Details of deployment ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
string ,
status:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Message ,
Required: False ,
}
string ,
author:
{
Description: Author ,
Required: False ,
}
string ,
deployer:
{
Description: Deployer ,
Required: False ,
}
string ,
author_email:
{
Description: AuthorEmail ,
Required: False ,
}
string ,
start_time:
{
Description: StartTime ,
Format: date-time ,
Required: False ,
}
string ,
end_time:
{
Description: EndTime ,
Format: date-time ,
Required: False ,
}
string ,
active:
{
Description: Active ,
Required: False ,
}
boolean ,
details:
{
Description: Detail ,
Required: False ,
}
string ,
}
,
}
Sites_DeleteInstanceDeploymentSlot (removed)
Description :  Delete the deployment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
id:
{
Description: Id of the deployment ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteInstanceIdentifiers (removed)
Description :  Gets all instance of a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of instance ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteInstanceIdentifiersSlot (removed)
Description :  Gets all instance of a web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of instance ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteHostNameBindings (removed)
Description :  Get web app hostname bindings
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteHostNameBindingsSlot (removed)
Description :  Get web app hostname bindings
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteHostNameBinding (removed)
Description :  Get web app binding for a hostname
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
hostName:
{
Description: Name of host ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Sites_CreateOrUpdateSiteHostNameBinding (removed)
Description :  Creates a web app hostname binding
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
hostName:
{
Description: Name of host ,
Required: True ,
}
string ,
hostNameBinding:
{
Description: Host name binding information ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Sites_DeleteSiteHostNameBinding (removed)
Description :  Deletes a host name binding
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
hostName:
{
Description: Name of host ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteHostNameBindingSlot (removed)
Description :  Get web app binding for a hostname
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
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: Name of host ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Sites_CreateOrUpdateSiteHostNameBindingSlot (removed)
Description :  Creates a web app hostname binding
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
hostName:
{
Description: Name of host ,
Required: True ,
}
string ,
hostNameBinding:
{
Description: Host name binding information ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
siteName:
{
Description: Web 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: Host name type ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Sites_DeleteSiteHostNameBindingSlot (removed)
Description :  Deletes a host name binding
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName:
{
Description: Name of resource group ,
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: Name of host ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteConfig (removed)
Description :  Gets the configuration of the web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_CreateOrUpdateSiteConfig (removed)
Description :  Update the configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_UpdateSiteConfig (removed)
Description :  Update the configuration of web app
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_GetSiteConfigSlot (removed)
Description :  Gets the configuration of the web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_CreateOrUpdateSiteConfigSlot (removed)
Description :  Update the configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_UpdateSiteConfigSlot (removed)
Description :  Update the configuration of web app
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteConfig:
{
Description: Request body that contains the configuration setting for the web app ,
Required: True ,
}
{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: Enable request tracing ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: Remote Debugging Enabled ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote Debugging Version ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: HTTP logging Enabled ,
Required: False ,
}
boolean ,
logsDirectorySizeLimit:
{
Description: HTTP Logs Directory size limit ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: Detailed error logging enabled ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Publishing password ,
Required: False ,
}
string ,
appSettings:
{
Description: Application Settings ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Site Metadata ,
Required: False ,
}
[
{
name:
{
Description: Pair name ,
Required: False ,
}
string ,
value:
{
Description: Pair value ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value ,
Required: False ,
}
string ,
type:
{
Description: Type of database ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
Required: False ,
}
string ,
use32BitWorkerProcess:
{
Description: Use 32 bit worker process ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: Web socket enabled. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: Always On ,
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:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
preloadEnabled:
{
Required: False ,
}
boolean ,
virtualDirectories:
{
Required: False ,
}
[
{
virtualPath:
{
Required: False ,
}
string ,
physicalPath:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types ,
Required: False ,
}
{
rampUpRules:
{
Description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl} ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: [Optional] Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: [Optional] 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: Auto heal enabled ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto heal rules ,
Required: False ,
}
{
triggers:
{
Description: Triggers - Conditions that describe when to execute the auto-heal actions ,
Required: False ,
}
{
requests:
{
Description: Requests - Defines a rule based on total requests ,
Required: False ,
}
{
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: PrivateBytesInKB - Defines a rule based on private bytes ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: StatusCodes - Defines a rule based on status codes ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: SubStatus ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: SlowRequests - Defines a rule based on request execution time ,
Required: False ,
}
{
timeTaken:
{
Description: TimeTaken ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: TimeInterval ,
Required: False ,
}
string ,
}
,
}
,
actions:
{
Description: Actions - Actions to be executed when a rule is triggered ,
Required: False ,
}
{
actionType:
{
Description: ActionType - predefined action to be taken ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: True ,
}
enum ,
customAction:
{
Description: CustomAction - 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: MinProcessExecutionTime - minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options ,
Required: False ,
}
string ,
vnetName:
{
Description: Vnet name ,
Required: False ,
}
string ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. ,
Required: False ,
}
[
string ,
]
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the web app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto swap slot name ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: Local mysql enabled ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Ip Security restrictions ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Sites_GetSiteSourceControl (removed)
Description :  Get the source control configuration of web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_CreateOrUpdateSiteSourceControl (removed)
Description :  Update the source control configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: Request body that contains the source control parameters ,
Required: True ,
}
{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_DeleteSiteSourceControl (removed)
Description :  Delete source control configuration of web app
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteSourceControl (removed)
Description :  Update the source control configuration of web app
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: Request body that contains the source control parameters ,
Required: True ,
}
{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_GetSiteSourceControlSlot (removed)
Description :  Get the source control configuration of web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_CreateOrUpdateSiteSourceControlSlot (removed)
Description :  Update the source control configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: Request body that contains the source control parameters ,
Required: True ,
}
{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_DeleteSiteSourceControlSlot (removed)
Description :  Delete source control configuration of web app
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteSourceControlSlot (removed)
Description :  Update the source control configuration of web app
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteSourceControl:
{
Description: Request body that contains the source control parameters ,
Required: True ,
}
{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
deploymentRollbackEnabled:
{
Description: Whether to manual or continuous integration ,
Required: False ,
}
boolean ,
isMercurial:
{
Description: Mercurial or Git repository type ,
Required: False ,
}
boolean ,
}
,
}
Sites_ListSiteAppSettingsSlot (removed)
Description :  Gets the application settings of web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_ListSiteAppSettings (removed)
Description :  Gets the application settings of web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteAppSettings (removed)
Description :  Updates the application settings of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
appSettings:
{
Description: Application settings of web app ,
Required: True ,
}
{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteAppSettingsSlot (removed)
Description :  Updates the application settings of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
appSettings:
{
Description: Application settings of web app ,
Required: True ,
}
{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_ListSiteConnectionStrings (removed)
Description :  Gets the connection strings associated with web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
Sites_ListSiteConnectionStringsSlot (removed)
Description :  Gets the connection strings associated with web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteConnectionStrings (removed)
Description :  Updates the connection strings associated with web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
connectionStrings:
{
Description: Connection strings associated with web app ,
Required: True ,
}
{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteConnectionStringsSlot (removed)
Description :  Updates the connection strings associated with web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
connectionStrings:
{
Description: Connection strings associated with web app ,
Required: True ,
}
{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Connection strings ,
Required: False ,
}
object ,
}
Sites_ListSiteAuthSettings (removed)
Description :  Gets the Authentication / Authorization settings associated with web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
Sites_ListSiteAuthSettingsSlot (removed)
Description :  Gets the Authentication / Authorization settings associated with web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
Sites_UpdateSiteAuthSettings (removed)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteAuthSettings:
{
Description: Auth settings associated with web app ,
Required: True ,
}
{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
Sites_UpdateSiteAuthSettingsSlot (removed)
Description :  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 resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteAuthSettings:
{
Description: Auth settings associated with web app ,
Required: True ,
}
{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enabled:
{
Description: Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. ,
Required: False ,
}
boolean ,
httpApiPrefixPath:
{
Description: Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. ,
Required: False ,
}
string ,
unauthenticatedClientAction:
{
Description: Gets or sets 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: Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
Description: Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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: Gets or sets 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. ,
}
,
Required: False ,
}
enum ,
tokenRefreshExtensionHours:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
issuer:
{
Description: Gets or sets 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 ,
allowedAudiences:
{
Description: Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. ,
Required: False ,
}
[
string ,
]
,
additionalLoginParams:
{
Description: Gets or sets a list of 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 ,
]
,
aadClientId:
{
Required: False ,
}
string ,
openIdIssuer:
{
Required: False ,
}
string ,
googleClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
googleOAuthScopes:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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 ,
facebookOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
twitterConsumerKey:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountClientId:
{
Description: Gets or sets 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: Gets or sets 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 ,
microsoftAccountOAuthScopes:
{
Description: Gets or sets 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 ,
]
,
}
Sites_ListSitePublishingCredentials (removed)
Description :  Gets the web app publishing credentials
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Sites_ListSitePublishingCredentialsSlot (removed)
Description :  Gets the web app publishing credentials
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Username (internal) ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing ,
Required: False ,
}
string ,
publishingPassword:
{
Description: Password used for publishing ,
Required: False ,
}
string ,
scmUri:
{
Description: Service Control Manager URI, including username and password ,
Required: False ,
}
string ,
}
,
}
Sites_ListSiteMetadata (removed)
Description :  Gets the web app meta data.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_ListSiteMetadataSlot (removed)
Description :  Gets the web app meta data.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteMetadata (removed)
Description :  Updates the meta data for web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
metadata:
{
Description: Meta data of web app ,
Required: True ,
}
{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_UpdateSiteMetadataSlot (removed)
Description :  Updates the meta data for web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
metadata:
{
Description: Meta data of web app ,
Required: True ,
}
{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings ,
Required: False ,
}
object ,
}
Sites_GetSiteLogsConfig (removed)
Description :  Gets the web app logs configuration
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
Sites_UpdateSiteLogsConfig (removed)
Description :  Updates the meta data for web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteLogsConfig:
{
Description: Site logs configuration ,
Required: True ,
}
{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
Sites_GetSiteLogsConfigSlot (removed)
Description :  Gets the web app logs configuration
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
Sites_UpdateSiteLogsConfigSlot (removed)
Description :  Updates the meta data for web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
siteLogsConfig:
{
Description: Site logs configuration ,
Required: True ,
}
{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: False ,
}
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: Enabled ,
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: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
failedRequestsTracing:
{
Description: Failed requests tracing configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
detailedErrorMessages:
{
Description: Detailed error messages configuration ,
Required: False ,
}
{
enabled:
{
Description: Enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
Sites_ListSitePremierAddOns (removed)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_ListSitePremierAddOnsSlot (removed)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
slot:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSitePremierAddOn (removed)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_AddSitePremierAddOn (removed)
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
premierAddOn:
{
Required: True ,
}
{
location:
{
Description: Geo 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 ,
}
object ,
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 ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_DeleteSitePremierAddOn (removed)
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSitePremierAddOnSlot (removed)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
slot:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_AddSitePremierAddOnSlot (removed)
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
premierAddOn:
{
Required: True ,
}
{
location:
{
Description: Geo 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 ,
}
object ,
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 ,
}
,
}
,
slot:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_DeleteSitePremierAddOnSlot (removed)
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
premierAddOnName:
{
Required: True ,
}
string ,
slot:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteBackupConfiguration (removed)
Description :  Gets the backup configuration for a web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Sites_GetSiteBackupConfigurationSlot (removed)
Description :  Gets the backup configuration for a web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Sites_UpdateSiteBackupConfiguration (removed)
Description :  Updates backup configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on backup request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Sites_UpdateSiteBackupConfigurationSlot (removed)
Description :  Updates backup configuration of web app
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on backup request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Sites_BackupSite (removed)
Description :  Creates web app backup
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on backup request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_BackupSiteSlot (removed)
Description :  Creates web app backup
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on backup request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_DiscoverSiteRestore (removed)
Description :  Discovers existing web app backups that can be restored
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
Sites_DiscoverSiteRestoreSlot (removed)
Description :  Discovers existing web app backups that can be restored
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
Sites_ListSiteBackups (removed)
Description :  Lists all available backups for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
Sites_ListSiteBackupsSlot (removed)
Description :  Lists all available backups for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
Sites_GetSiteBackupStatus (removed)
Description :  Gets status of a web app backup that may be in progress.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_DeleteBackup (removed)
Description :  Deletes a backup from Azure Storage
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_GetSiteBackupStatusSlot (removed)
Description :  Gets status of a web app backup that may be in progress.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_DeleteBackupSlot (removed)
Description :  Deletes a backup from Azure Storage
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup ,
Required: True ,
}
string ,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_GetSiteBackupStatusSecretsSlot (removed)
Description :  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 resource group ,
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:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_GetSiteBackupStatusSecrets (removed)
Description :  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 resource group ,
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:
{
Required: False ,
}
{
name:
{
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: False ,
}
string ,
backupSchedule:
{
Description: Schedule for the backup if it is executed periodically ,
Required: False ,
}
{
frequencyInterval:
{
Description: How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) ,
Format: int32 ,
Required: False ,
}
integer ,
frequencyUnit:
{
Description: How often should be the backup 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: False ,
}
boolean ,
retentionPeriodInDays:
{
Description: After how many days backups should be deleted ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: When the schedule should start working ,
Format: date-time ,
Required: False ,
}
string ,
lastExecutionTime:
{
Description: The last time when this schedule was triggered ,
Format: date-time ,
Required: False ,
}
string ,
}
,
databases:
{
Description: Databases included in the backup ,
Required: False ,
}
[
{
databaseType:
{
Description: SqlAzure / MySql ,
Required: False ,
}
string ,
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/restored. If the restore should happen to a new database, the database name inside is the new one. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Type of the backup ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 ,
}
,
}
Sites_RestoreSite (removed)
Description :  Restores a web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup to restore ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
operationId:
{
Description: When server starts the restore process, it will return an OperationId identifying that particular restore operation ,
Required: False ,
}
string ,
}
,
}
Sites_RestoreSiteSlot (removed)
Description :  Restores a web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
backupId:
{
Description: Id of backup to restore ,
Required: True ,
}
string ,
request:
{
Description: Information on restore request ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
storageAccountUrl:
{
Description: SAS URL to the container ,
Required: False ,
}
string ,
blobName:
{
Description: Name of a blob which contains the backup ,
Required: False ,
}
string ,
overwrite:
{
Description: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. ,
Required: False ,
}
boolean ,
siteName:
{
Description: Name of a site (Web 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: SqlAzure / MySql ,
Required: False ,
}
string ,
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/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 a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to the site object when it is being restored, but that might fail due to conflicts during the operation. ,
Required: False ,
}
boolean ,
operationType:
{
Description: Operation type ,
Enum:
{
Default: No description available. ,
Clone: No description available. ,
Relocation: No description available. ,
}
,
Required: True ,
}
enum ,
adjustConnectionStrings:
{
Description: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site ,
Required: False ,
}
boolean ,
hostingEnvironment:
{
Description: App Service Environment name, if needed (only when restoring a site to an App Service Environment) ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
operationId:
{
Description: When server starts the restore process, it will return an OperationId identifying that particular restore operation ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteUsages (removed)
Description :  Gets the quota usage numbers for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
$filter:
{
Description: Return only usages specified in the filter. Filter is specified by using OData syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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 ,
}
Sites_GetSiteUsagesSlot (removed)
Description :  Gets the quota usage numbers for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages
{
resourceGroupName:
{
Description: Name of resource group ,
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 ,
$filter:
{
Description: Return only usages specified in the filter. Filter is specified by using OData syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
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 ,
}
Sites_GetSiteMetrics (removed)
Description :  Gets metrics for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
details:
{
Description: If true, metric details are included in response ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of metric ,
Required: False ,
}
{
value:
{
Description: metric name value ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values ,
Required: False ,
}
[
{
timeStamp:
{
Description: Value timestamp ,
Required: False ,
}
string ,
average:
{
Description: Value average ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
properties:
{
Description: Properties ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteMetricsSlot (removed)
Description :  Gets metrics for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics
{
resourceGroupName:
{
Description: Name of resource group ,
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 ,
details:
{
Description: If true, metric details are included in response ,
Required: False ,
}
boolean ,
$filter:
{
Description: Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
name:
{
Description: Name of metric ,
Required: False ,
}
{
value:
{
Description: metric name value ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized metric name value ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Metric unit ,
Required: False ,
}
string ,
timeGrain:
{
Description: Metric granularity. E.g PT1H, PT5M, P1D ,
Required: False ,
}
string ,
startTime:
{
Description: Metric start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Metric end time ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Metric resource Id ,
Required: False ,
}
string ,
metricValues:
{
Description: Metric values ,
Required: False ,
}
[
{
timeStamp:
{
Description: Value timestamp ,
Required: False ,
}
string ,
average:
{
Description: Value average ,
Format: float ,
Required: False ,
}
number ,
minimum:
{
Description: Value minimum ,
Format: float ,
Required: False ,
}
number ,
maximum:
{
Description: Value maximum ,
Format: float ,
Required: False ,
}
number ,
total:
{
Description: Value total ,
Format: float ,
Required: False ,
}
number ,
count:
{
Description: Value count ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
properties:
{
Description: Properties ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteMetricDefinitionsSlot (removed)
Description :  Gets metric definitions for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_GetSiteMetricDefinitions (removed)
Description :  Gets metric definitions for web app
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the metric ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: Primary aggregation type ,
Required: False ,
}
string ,
metricAvailabilities:
{
Description: List of time grains supported for the metric together with retention period ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain ,
Required: False ,
}
string ,
retention:
{
Description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Friendly name shown in the UI ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Sites_ListSitePublishingProfileXml (removed)
Description :  Gets the publishing profile for web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
options:
{
Description: Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format. ,
Required: True ,
}
{
format:
{
Description: Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}
Sites_ListSitePublishingProfileXmlSlot (removed)
Description :  Gets the publishing profile for web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
options:
{
Description: Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format. ,
Required: True ,
}
{
format:
{
Description: Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp ,
Required: False ,
}
string ,
}
,
slot:
{
Description: Name of web app slot. If not specified then will default to production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}
Sites_RestartSiteSlot (removed)
Description :  Restarts web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart
{
resourceGroupName:
{
Description: Name of resource group ,
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 ,
softRestart:
{
Description: Soft restart applies the configuration settings and restarts the app if necessary. Hard restart always restarts and reprovisions the app ,
Required: False ,
}
boolean ,
synchronous:
{
Description: If true then the API will block until the app has been restarted ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_RestartSite (removed)
Description :  Restarts web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
softRestart:
{
Description: Soft restart applies the configuration settings and restarts the app if necessary. Hard restart always restarts and reprovisions the app ,
Required: False ,
}
boolean ,
synchronous:
{
Description: If true then the API will block until the app has been restarted ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_StartSite (removed)
Description :  Starts web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_StartSiteSlot (removed)
Description :  Starts web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_StopSite (removed)
Description :  Stops web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_StopSiteSlot (removed)
Description :  Stops web app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_SyncSiteRepository (removed)
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_SyncSiteRepositorySlot (removed)
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync
{
resourceGroupName:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
slot:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GenerateNewSitePublishingPasswordSlot (removed)
Description :  Generates new random app publishing password
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword
{
resourceGroupName:
{
Description: Name of resource group ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GenerateNewSitePublishingPassword (removed)
Description :  Generates new random app publishing password
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
name:
{
Description: Name of web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_GetSiteRelayServiceConnection (removed)
Description :  Retrieves a BizTalk Hybrid Connection identified by its entity name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_CreateOrUpdateSiteRelayServiceConnection (removed)
Description :  Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the Hybrid Connection ,
Required: True ,
}
{
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_DeleteSiteRelayServiceConnection (removed)
Description :  Removes the association to a BizTalk Hybrid Connection, identified by its entity name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteRelayServiceConnection (removed)
Description :  Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the Hybrid Connection ,
Required: True ,
}
{
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_GetSiteRelayServiceConnectionSlot (removed)
Description :  Retrieves a BizTalk Hybrid Connection identified by its entity name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for the web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_CreateOrUpdateSiteRelayServiceConnectionSlot (removed)
Description :  Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the Hybrid Connection ,
Required: True ,
}
{
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: The name of the slot for the web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_DeleteSiteRelayServiceConnectionSlot (removed)
Description :  Removes the association to a BizTalk Hybrid Connection, identified by its entity name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for the web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Sites_UpdateSiteRelayServiceConnectionSlot (removed)
Description :  Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
entityName:
{
Description: The name by which the Hybrid Connection is identified ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The details of the Hybrid Connection ,
Required: True ,
}
{
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: The name of the slot for the web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_ListSiteRelayServiceConnectionsSlot (removed)
Description :  Retrieves all BizTalk Hybrid Connections associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection
{
resourceGroupName:
{
Description: The resource group name ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_ListSiteRelayServiceConnections (removed)
Description :  Retrieves all BizTalk Hybrid Connections associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}
Sites_GetSiteVnetGatewaySlot (removed)
Description :  Retrieves a Virtual Network connection gateway associated with this web app and virtual network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (404)

{}
Sites_CreateOrUpdateSiteVNETConnectionGatewaySlot (removed)
Description :  Updates the Virtual Network Gateway.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties to update this gateway with. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
Sites_UpdateSiteVNETConnectionGatewaySlot (removed)
Description :  Updates the Virtual Network Gateway.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties to update this gateway with. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
,
slot:
{
Description: The name of the slot for this web app. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteVnetGateway (removed)
Description :  Retrieves a Virtual Network connection gateway associated with this web app and virtual network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (404)

{}
Sites_CreateOrUpdateSiteVNETConnectionGateway (removed)
Description :  Updates the Virtual Network Gateway.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties to update this gateway with. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
Sites_UpdateSiteVNETConnectionGateway (removed)
Description :  Updates the Virtual Network Gateway.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
vnetName:
{
Description: The name of the Virtual Network ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the gateway. The only gateway that exists presently is "primary" ,
Required: True ,
}
string ,
connectionEnvelope:
{
Description: The properties to update this gateway with. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetName:
{
Description: The VNET name. ,
Required: False ,
}
string ,
vpnPackageUri:
{
Description: The URI where the Vpn package can be downloaded ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteVNETConnections (removed)
Description :  Retrieves a list of all Virtual Network Connections associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections
{
resourceGroupName:
{
Description: The resource group name ,
Required: True ,
}
string ,
name:
{
Description: The name of the web app ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
Sites_GetSiteVNETConnectionsSlot (removed)
Description :  Retrieves a list of all Virtual Network Connections associated with this web app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections
{
resourceGroupName:
{
Description: The resource group name ,
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: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
vnetResourceId:
{
Description: The vnet 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:
{
Required: False ,
}
{
name:
{
Description: The name of this route. This is only returned by the server and does not need to be set by the client. ,
Required: False ,
}
string ,
startAddress:
{
Description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. ,
Required: False ,
}
string ,
endAddress:
{
Description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. ,
Required: False ,
}
string ,
routeType:
{
Description: The type of route this is: DEFAULT - By default, every web 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 web app only These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them with new INHERITED routes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resyncRequired:
{
Description: Flag to determine if a resync is required ,
Required: False ,
}
boolean ,
dnsServers:
{
Description: Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. ,
Required: False ,
}
string ,
}
,
}
TopLevelDomains_GetGetTopLevelDomains (removed)
Description :  Lists all top level domains supported for registration
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the top level domain ,
Required: False ,
}
string ,
privacy:
{
Description: If true then the top level domain supports domain privacy ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
TopLevelDomains_GetTopLevelDomain (removed)
Description :  Gets details of a top level domain
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}
{
name:
{
Description: Name of the top level domain ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the top level domain ,
Required: False ,
}
string ,
privacy:
{
Description: If true then the top level domain supports domain privacy ,
Required: False ,
}
boolean ,
}
,
}
TopLevelDomains_ListTopLevelDomainAgreements (removed)
Description :  Lists legal agreements that user needs to accept before purchasing domain
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}/listAgreements
{
name:
{
Description: Name of the top level domain ,
Required: True ,
}
string ,
agreementOption:
{
Description: Domain agreement options ,
Required: True ,
}
{
includePrivacy:
{
Description: If true then the list of agreements will include agreements for domain privacy as well. ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
agreementKey:
{
Description: Unique identifier for the agreement ,
Required: False ,
}
string ,
title:
{
Description: Agreement title ,
Required: False ,
}
string ,
content:
{
Description: Agreement details ,
Required: False ,
}
string ,
url:
{
Description: Url where a copy of the agreement details is hosted ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Usage_GetUsage (removed)
Description :  Returns usage records for specified subscription and resource groups
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web.Admin/environments/{environmentName}/usage
{
resourceGroupName:
{
Description: Name of resource group ,
Required: True ,
}
string ,
environmentName:
{
Description: Environment name ,
Required: True ,
}
string ,
lastId:
{
Description: Last marker that was returned from the batch ,
Required: True ,
}
string ,
batchSize:
{
Description: size of the batch to be returned. ,
Format: int32 ,
Required: True ,
}
integer ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}