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

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

Certificates_List (new)
Description :  Get all certificates for a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Certificate resource specific 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. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Certificates_ListByResourceGroup (new)
Description :  Get all certificates in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Certificates_Get (new)
Description :  Get a certificate.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
Certificates_CreateOrUpdate (new)
Description :  Create or update a certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate, if it exists already. ,
Required: True ,
}
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
Certificates_Delete (new)
Description :  Delete a certificate.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate, if it exists already. ,
Required: True ,
}
{
properties:
{
Description: CertificatePatchResource resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
DeletedWebApps_List (new)
Description :  Get all deleted apps for a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
id:
{
Description: Numeric id for the deleted site ,
Format: int32 ,
Required: False ,
}
integer ,
deletedTimestamp:
{
Description: Time in UTC when the app was deleted. ,
Required: False ,
}
string ,
subscription:
{
Description: Subscription containing the deleted site ,
Required: False ,
}
string ,
resourceGroup:
{
Description: ResourceGroup that contained the deleted site ,
Required: False ,
}
string ,
name:
{
Description: Name of the deleted site ,
Required: False ,
}
string ,
slot:
{
Description: Slot of the deleted site ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_ListHostingEnvironmentDetectorResponses (new)
Description :  List Hosting Environment Detector Responses
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetHostingEnvironmentDetectorResponse (new)
Description :  Get Hosting Environment Detector Response
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: App Service Environment Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
Diagnostics_ListSiteDetectorResponses (new)
Description :  List Site Detector Responses
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDetectorResponse (new)
Description :  Get site detector response
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
Diagnostics_ListSiteDiagnosticCategories (new)
Description :  Get Diagnostics Categories
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDiagnosticCategory (new)
Description :  Get Diagnostics Category
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
Required: False ,
}
string ,
}
,
}
Diagnostics_ListSiteAnalyses (new)
Description :  Get Site Analyses
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AnalysisDefinition resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the Analysis ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteAnalysis (new)
Description :  Get Site Analysis
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
analysisName:
{
Description: Analysis Resource Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorDefinition resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDetector (new)
Description :  Get Detector
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorDefinition resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_ExecuteSiteDetector (new)
Description :  Execute Detector
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDetectorResponseSlot (new)
Description :  Get site detector response
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
Diagnostics_ListSiteDiagnosticCategoriesSlot (new)
Description :  Get Diagnostics Categories
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDiagnosticCategorySlot (new)
Description :  Get Diagnostics Category
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
Required: False ,
}
string ,
}
,
}
Diagnostics_ListSiteAnalysesSlot (new)
Description :  Get Site Analyses
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AnalysisDefinition resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the Analysis ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteAnalysisSlot (new)
Description :  Get Site Analysis
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
analysisName:
{
Description: Analysis Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot - optional ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
analysisName:
{
Description: Analysis Resource Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorDefinition resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDetectorSlot (new)
Description :  Get Detector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorDefinition resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_ExecuteSiteDetectorSlot (new)
Description :  Execute Detector
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Application stack name. ,
Required: False ,
}
string ,
display:
{
Description: Application stack display name. ,
Required: False ,
}
string ,
dependency:
{
Description: Application stack dependency. ,
Required: False ,
}
string ,
majorVersions:
{
Description: List of major versions available. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack major version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack major version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default major version; otherwise, false. ,
Required: False ,
}
boolean ,
minorVersions:
{
Description: Minor versions associated with the major version. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack minor version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack minor version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default minor version; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
frameworks:
{
Description: List of frameworks associated with application stack. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Provider_ListOperations (new)
Description :  Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Required: False ,
}
string ,
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 ,
}
Provider_GetAvailableStacksOnPrem (new)
Description :  Get available application frameworks and their versions
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Application stack name. ,
Required: False ,
}
string ,
display:
{
Description: Application stack display name. ,
Required: False ,
}
string ,
dependency:
{
Description: Application stack dependency. ,
Required: False ,
}
string ,
majorVersions:
{
Description: List of major versions available. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack major version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack major version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default major version; otherwise, false. ,
Required: False ,
}
boolean ,
minorVersions:
{
Description: Minor versions associated with the major version. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack minor version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack minor version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default minor version; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
frameworks:
{
Description: List of frameworks associated with application stack. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Recommendations_List (new)
Description :  List all recommendations for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations
{
featured:
{
Description: Specify true to return only the most critical recommendations. The default is false, which returns all recommendations. ,
Required: False ,
}
boolean ,
$filter:
{
Description: Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification' and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[PT1H|PT1M|P1D] ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is 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: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Recommendations_ResetAllFilters (new)
Description :  Reset all recommendation opt-out settings for a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}
Recommendations_DisableRecommendationForSubscription (new)
Description :  Disables the specified rule so it will not apply to a subscription in the future.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}
Recommendations_ListHistoryForWebApp (new)
Description :  Get past recommendations for an app, optionally specified by the time range.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Name of the app. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification' and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[PT1H|PT1M|P1D] ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is 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: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Recommendations_ListRecommendedRulesForWebApp (new)
Description :  Get all recommendations for an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Name of the app. ,
Required: True ,
}
string ,
featured:
{
Description: Specify true to return only the most critical recommendations. The default is false, which returns all recommendations. ,
Required: False ,
}
boolean ,
$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: Your Azure subscription ID. This is 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: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Recommendations_DisableAllForWebApp (new)
Description :  Disable all recommendations for an app.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}
Recommendations_ResetAllFiltersForWebApp (new)
Description :  Reset all recommendation opt-out settings for an app.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}
Recommendations_GetRuleDetailsByWebApp (new)
Description :  Get a recommendation rule for an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Name of the app. ,
Required: True ,
}
string ,
name:
{
Description: Name of the recommendation. ,
Required: True ,
}
string ,
updateSeen:
{
Description: Specify true to update the last-seen timestamp of the recommendation object. ,
Required: False ,
}
boolean ,
recommendationId:
{
Description: The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: RecommendationRule resource specific properties ,
Required: False ,
}
{
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. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: Localized detailed description of the rule. ,
Required: False ,
}
string ,
actionName:
{
Description: Name of action that is recommended by this rule in string. ,
Required: False ,
}
string ,
level:
{
Description: Level of impact indicating how critical this rule is. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of available channels that this rule applies. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: An array of category tags that the rule contains. ,
Required: False ,
}
[
string ,
]
,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. Applicable to dynamic rule only. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. Applicable to dynamic rule only. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. Applicable to dynamic rule only. ,
Required: False ,
}
string ,
}
,
}
Recommendations_DisableRecommendationForSite (new)
Description :  Disables the specific rule for a web site permanently.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}
ResourceHealthMetadata_List (new)
Description :  List all ResourceHealthMetadata for all sites in the subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ResourceHealthMetadata_ListByResourceGroup (new)
Description :  List all ResourceHealthMetadata for all sites in the resource group in the subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ResourceHealthMetadata_ListBySite (new)
Description :  Gets the category of ResourceHealthMetadata to use for the given site as a collection
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ResourceHealthMetadata_GetBySite (new)
Description :  Gets the category of ResourceHealthMetadata to use for the given site
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ResourceHealthMetadata_ListBySiteSlot (new)
Description :  Gets the category of ResourceHealthMetadata to use for the given site as a collection
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ResourceHealthMetadata_GetBySiteSlot (new)
Description :  Gets the category of ResourceHealthMetadata to use for the given site
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: User resource specific properties ,
Required: False ,
}
{
name:
{
Description: Username ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing. ,
Required: True ,
}
string ,
publishingPassword:
{
Description: Password used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHash:
{
Description: Password hash used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHashSalt:
{
Description: Password hash salt used for publishing. ,
Format: password ,
Required: False ,
}
string ,
}
,
}
UpdatePublishingUser (new)
Description :  Updates publishing user
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: User resource specific properties ,
Required: False ,
}
{
name:
{
Description: Username ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing. ,
Required: True ,
}
string ,
publishingPassword:
{
Description: Password used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHash:
{
Description: Password hash used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHashSalt:
{
Description: Password hash salt used for publishing. ,
Format: password ,
Required: False ,
}
string ,
}
,
}
ListSourceControls (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: True ,
}
[
{
properties:
{
Description: SourceControl resource specific 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 ,
}
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:
{
Description: SourceControl resource specific 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 ,
}
,
}
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:
{
Description: SourceControl resource specific 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:
{
Description: SourceControl resource specific 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 ,
}
,
}
CheckNameAvailability (new)
Description :  Check if a resource name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability
{
request:
{
Description: Name availability request. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Enum:
{
Site: No description available. ,
Slot: No description available. ,
HostingEnvironment: No description available. ,
PublishingUser: No description available. ,
Microsoft.Web/sites: No description available. ,
Microsoft.Web/sites/slots: No description available. ,
Microsoft.Web/hostingEnvironments: No description available. ,
Microsoft.Web/publishingUsers: No description available. ,
}
,
Required: True ,
}
enum ,
isFqdn:
{
Description: Is fully qualified domain name. ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: true indicates name is valid and available. false indicates the name is invalid, unavailable, or both. ,
Required: False ,
}
boolean ,
reason:
{
Description: Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name. ,
Required: False ,
}
string ,
}
BillingMeters_List (new)
Description :  Gets a list of meters for a given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters
{
billingLocation:
{
Description: Azure Location of billable resource ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is 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 Billing Meters. ,
Required: True ,
}
[
{
properties:
{
Description: BillingMeter resource specific properties ,
Required: False ,
}
{
meterId:
{
Description: Meter GUID onboarded in Commerce ,
Required: False ,
}
string ,
billingLocation:
{
Description: Azure Location of billable resource ,
Required: False ,
}
string ,
shortName:
{
Description: Short Name from App Service Azure pricing Page ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the meter ,
Required: False ,
}
string ,
resourceType:
{
Description: App Service resource type meter used for ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
GetSubscriptionDeploymentLocations (new)
Description :  Gets list of available geo regions plus ministamps
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions
{
sku:
{
Description: Name of SKU used to filter the regions. ,
Required: False ,
}
string ,
linuxWorkersEnabled:
{
Description: Specify true if you want to filter to only regions that support Linux workers. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: GeoRegion resource specific properties ,
Required: False ,
}
{
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 ,
}
ListSiteIdentifiersAssignedToHostName (new)
Description :  List all apps that are assigned to a hostname.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/listSitesAssignedToHostName
{
nameIdentifier:
{
Description: Hostname information. ,
Required: True ,
}
{
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
ListPremierAddOnOffers (new)
Description :  List all premier add-on offers.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: PremierAddOnOffer resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on offer Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on offer Vendor. ,
Required: False ,
}
string ,
name:
{
Description: Premier add on offer Name. ,
Required: False ,
}
string ,
promoCodeRequired:
{
Description: true if promotion code is required; otherwise, false. ,
Required: False ,
}
boolean ,
quota:
{
Description: Premier add on offer Quota. ,
Format: int32 ,
Required: False ,
}
integer ,
webHostingPlanRestrictions:
{
Description: App Service plans this offer is restricted to. ,
Enum:
{
None: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
privacyPolicyUrl:
{
Description: Privacy policy URL. ,
Required: False ,
}
string ,
legalTermsUrl:
{
Description: Legal terms URL. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Marketplace offer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
ListSkus (new)
Description :  List all SKUs.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
resourceType:
{
Description: Resource type that this SKU applies to. ,
Required: False ,
}
string ,
skus:
{
Description: List of SKUs the subscription is able to use. ,
Required: False ,
}
[
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
VerifyHostingEnvironmentVnet (new)
Description :  Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/verifyHostingEnvironmentVnet
{
parameters:
{
Description: VNET information ,
Required: True ,
}
{
properties:
{
Description: VnetParameters resource specific properties ,
Required: False ,
}
{
vnetResourceGroup:
{
Description: The Resource Group of the VNET to be validated ,
Required: False ,
}
string ,
vnetName:
{
Description: The name of the VNET to be validated ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: The subnet name to be validated ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetValidationFailureDetails resource specific properties ,
Required: False ,
}
{
failed:
{
Description: A flag describing whether or not validation failed. ,
Required: False ,
}
boolean ,
failedTests:
{
Description: A list of tests that failed in the validation. ,
Required: False ,
}
[
{
properties:
{
Description: VnetValidationTestFailure resource specific properties ,
Required: False ,
}
{
testName:
{
Description: The name of the test that failed. ,
Required: False ,
}
string ,
details:
{
Description: The details of what caused the failure, e.g. the blocking rule name, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
Move (new)
Description :  Move resources between resource groups.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
moveResourceEnvelope:
{
Description: Object that represents the resource to move. ,
Required: True ,
}
{
targetResourceGroup:
{
Required: False ,
}
string ,
resources:
{
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Validate (new)
Description :  Validate if a resource can be created.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
validateRequest:
{
Description: Request with the resources to validate. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Enum:
{
ServerFarm: No description available. ,
Site: No description available. ,
}
,
Required: True ,
}
enum ,
location:
{
Description: Expected location of the resource. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the resource to validate. ,
Required: True ,
}
{
serverFarmId:
{
Description: ARM resource ID of an App Service plan that would host the app. ,
Required: False ,
}
string ,
skuName:
{
Description: Name of the target SKU for the App Service plan. ,
Required: False ,
}
string ,
needLinuxWorkers:
{
Description: true if App Service plan is for Linux workers; otherwise, false. ,
Required: False ,
}
boolean ,
isSpot:
{
Description: true if App Service plan is for Spot instances; otherwise, false. ,
Required: False ,
}
boolean ,
capacity:
{
Description: Target capacity of the App Service plan (number of VMs). ,
Format: int32 ,
Required: False ,
}
integer ,
hostingEnvironment:
{
Description: Name of App Service Environment where app or App Service plan should be created. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
moveResourceEnvelope:
{
Description: Object that represents the resource to move. ,
Required: True ,
}
{
targetResourceGroup:
{
Required: False ,
}
string ,
resources:
{
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Certificates_List (removed)
Description :  Get all certificates for a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Certificate resource specific 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. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Certificates_ListByResourceGroup (removed)
Description :  Get all certificates in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Certificates_Get (removed)
Description :  Get a certificate.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
Certificates_CreateOrUpdate (removed)
Description :  Create or update a certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate, if it exists already. ,
Required: True ,
}
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
Certificates_Delete (removed)
Description :  Delete a certificate.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Details of certificate, if it exists already. ,
Required: True ,
}
{
properties:
{
Description: CertificatePatchResource resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the certificate. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
hostNames:
{
Description: Host names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
pfxBlob:
{
Description: Pfx blob. ,
Format: byte ,
Required: False ,
}
string ,
siteName:
{
Description: App name. ,
Required: False ,
}
string ,
selfLink:
{
Description: Self link. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
cerBlob:
{
Description: Raw bytes of .cer file ,
Format: byte ,
Required: False ,
}
string ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: Specification for the App Service Environment to use for the certificate. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
keyVaultId:
{
Description: Key Vault Csm resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
keyVaultSecretStatus:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
geoRegion:
{
Description: Region of the certificate. ,
Required: False ,
}
string ,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
}
,
}
DeletedWebApps_List (removed)
Description :  Get all deleted apps for a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
id:
{
Description: Numeric id for the deleted site ,
Format: int32 ,
Required: False ,
}
integer ,
deletedTimestamp:
{
Description: Time in UTC when the app was deleted. ,
Required: False ,
}
string ,
subscription:
{
Description: Subscription containing the deleted site ,
Required: False ,
}
string ,
resourceGroup:
{
Description: ResourceGroup that contained the deleted site ,
Required: False ,
}
string ,
name:
{
Description: Name of the deleted site ,
Required: False ,
}
string ,
slot:
{
Description: Slot of the deleted site ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_ListHostingEnvironmentDetectorResponses (removed)
Description :  List Hosting Environment Detector Responses
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetHostingEnvironmentDetectorResponse (removed)
Description :  Get Hosting Environment Detector Response
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: App Service Environment Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
Diagnostics_ListSiteDetectorResponses (removed)
Description :  List Site Detector Responses
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDetectorResponse (removed)
Description :  Get site detector response
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
Diagnostics_ListSiteDiagnosticCategories (removed)
Description :  Get Diagnostics Categories
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDiagnosticCategory (removed)
Description :  Get Diagnostics Category
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
Required: False ,
}
string ,
}
,
}
Diagnostics_ListSiteAnalyses (removed)
Description :  Get Site Analyses
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AnalysisDefinition resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the Analysis ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteAnalysis (removed)
Description :  Get Site Analysis
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
analysisName:
{
Description: Analysis Resource Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorDefinition resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDetector (removed)
Description :  Get Detector
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorDefinition resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_ExecuteSiteDetector (removed)
Description :  Execute Detector
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDetectorResponseSlot (removed)
Description :  Get site detector response
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DetectorResponse resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: metadata for the detector ,
Required: False ,
}
{
description:
{
Description: Short description of the detector and its purpose ,
Required: False ,
}
string ,
category:
{
Description: Support Category ,
Required: False ,
}
string ,
subCategory:
{
Description: Support Sub Category ,
Required: False ,
}
string ,
supportTopicId:
{
Description: Support Topic Id ,
Required: False ,
}
string ,
}
,
dataset:
{
Description: Data Set ,
Required: False ,
}
[
{
table:
{
Description: Data in table form ,
Required: False ,
}
{
tableName:
{
Description: Name of the table ,
Required: False ,
}
string ,
columns:
{
Description: List of columns with data types ,
Required: False ,
}
[
{
columnName:
{
Description: Name of the column ,
Required: False ,
}
string ,
dataType:
{
Description: Data type which looks like 'String' or 'Int32'. ,
Required: False ,
}
string ,
columnType:
{
Description: Column Type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Raw row values ,
Required: False ,
}
[
string ,
]
,
}
,
renderingProperties:
{
Description: Properties that describe how the table should be rendered ,
Required: False ,
}
{
renderingType:
{
Description: Rendering Type ,
Enum:
{
NoGraph: No description available. ,
Table: No description available. ,
TimeSeries: No description available. ,
TimeSeriesPerInstance: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title of data ,
Required: False ,
}
string ,
description:
{
Description: Description of the data that will help it be interpreted ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
Diagnostics_ListSiteDiagnosticCategoriesSlot (removed)
Description :  Get Diagnostics Categories
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDiagnosticCategorySlot (removed)
Description :  Get Diagnostics Category
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: DiagnosticCategory resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the diagnostic category ,
Required: False ,
}
string ,
}
,
}
Diagnostics_ListSiteAnalysesSlot (removed)
Description :  Get Site Analyses
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AnalysisDefinition resource specific properties ,
Required: False ,
}
{
description:
{
Description: Description of the Analysis ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteAnalysisSlot (removed)
Description :  Get Site Analysis
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
analysisName:
{
Description: Analysis Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot - optional ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
analysisName:
{
Description: Analysis Resource Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorDefinition resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_GetSiteDetectorSlot (removed)
Description :  Get Detector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Diagnostic Category ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DetectorDefinition resource specific properties ,
Required: False ,
}
{
displayName:
{
Description: Display name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Description of the detector ,
Required: False ,
}
string ,
rank:
{
Description: Detector Rank ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Flag representing whether detector is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Diagnostics_ExecuteSiteDetectorSlot (removed)
Description :  Execute Detector
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Site Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Detector Resource Name ,
Required: True ,
}
string ,
diagnosticCategory:
{
Description: Category Name ,
Required: True ,
}
string ,
slot:
{
Description: Slot Name ,
Required: True ,
}
string ,
startTime:
{
Description: Start Time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End Time ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: Time Grain ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Application stack name. ,
Required: False ,
}
string ,
display:
{
Description: Application stack display name. ,
Required: False ,
}
string ,
dependency:
{
Description: Application stack dependency. ,
Required: False ,
}
string ,
majorVersions:
{
Description: List of major versions available. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack major version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack major version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default major version; otherwise, false. ,
Required: False ,
}
boolean ,
minorVersions:
{
Description: Minor versions associated with the major version. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack minor version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack minor version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default minor version; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
frameworks:
{
Description: List of frameworks associated with application stack. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Provider_ListOperations (removed)
Description :  Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Required: False ,
}
string ,
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 ,
}
Provider_GetAvailableStacksOnPrem (removed)
Description :  Get available application frameworks and their versions
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Application stack name. ,
Required: False ,
}
string ,
display:
{
Description: Application stack display name. ,
Required: False ,
}
string ,
dependency:
{
Description: Application stack dependency. ,
Required: False ,
}
string ,
majorVersions:
{
Description: List of major versions available. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack major version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack major version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default major version; otherwise, false. ,
Required: False ,
}
boolean ,
minorVersions:
{
Description: Minor versions associated with the major version. ,
Required: False ,
}
[
{
displayVersion:
{
Description: Application stack minor version (display only). ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Application stack minor version (runtime only). ,
Required: False ,
}
string ,
isDefault:
{
Description: true if this is the default minor version; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
frameworks:
{
Description: List of frameworks associated with application stack. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Recommendations_List (removed)
Description :  List all recommendations for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations
{
featured:
{
Description: Specify true to return only the most critical recommendations. The default is false, which returns all recommendations. ,
Required: False ,
}
boolean ,
$filter:
{
Description: Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification' and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[PT1H|PT1M|P1D] ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is 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: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Recommendations_ResetAllFilters (removed)
Description :  Reset all recommendation opt-out settings for a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}
Recommendations_DisableRecommendationForSubscription (removed)
Description :  Disables the specified rule so it will not apply to a subscription in the future.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}
Recommendations_ListHistoryForWebApp (removed)
Description :  Get past recommendations for an app, optionally specified by the time range.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Name of the app. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification' and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[PT1H|PT1M|P1D] ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is 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: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Recommendations_ListRecommendedRulesForWebApp (removed)
Description :  Get all recommendations for an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Name of the app. ,
Required: True ,
}
string ,
featured:
{
Description: Specify true to return only the most critical recommendations. The default is false, which returns all recommendations. ,
Required: False ,
}
boolean ,
$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: Your Azure subscription ID. This is 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: Recommendation resource specific properties ,
Required: False ,
}
{
creationTime:
{
Description: Timestamp when this instance was created. ,
Format: date-time ,
Required: False ,
}
string ,
recommendationId:
{
Description: A GUID value that each recommendation object is associated with. ,
Format: uuid ,
Required: False ,
}
string ,
resourceId:
{
Description: Full ARM resource ID string that this recommendation object is associated with. ,
Required: False ,
}
string ,
resourceScope:
{
Description: Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. ,
Enum:
{
ServerFarm: No description available. ,
Subscription: No description available. ,
WebSite: No description available. ,
}
,
Required: False ,
}
enum ,
ruleName:
{
Description: Unique name of the rule. ,
Required: False ,
}
string ,
displayName:
{
Description: UI friendly name of the rule (may not be unique). ,
Required: False ,
}
string ,
message:
{
Description: Recommendation text. ,
Required: False ,
}
string ,
level:
{
Description: Level indicating how critical this recommendation can impact. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of channels that this recommendation can apply. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
startTime:
{
Description: The beginning time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time in UTC of a range that the recommendation refers to. ,
Format: date-time ,
Required: False ,
}
string ,
nextNotificationTime:
{
Description: When to notify this recommendation next in UTC. Null means that this will never be notified anymore. ,
Format: date-time ,
Required: False ,
}
string ,
notificationExpirationTime:
{
Description: Date and time in UTC when this notification expires. ,
Format: date-time ,
Required: False ,
}
string ,
notifiedTime:
{
Description: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: A metric value measured by the rule. ,
Format: double ,
Required: False ,
}
number ,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
Recommendations_DisableAllForWebApp (removed)
Description :  Disable all recommendations for an app.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}
Recommendations_ResetAllFiltersForWebApp (removed)
Description :  Reset all recommendation opt-out settings for an app.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}
Recommendations_GetRuleDetailsByWebApp (removed)
Description :  Get a recommendation rule for an app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
siteName:
{
Description: Name of the app. ,
Required: True ,
}
string ,
name:
{
Description: Name of the recommendation. ,
Required: True ,
}
string ,
updateSeen:
{
Description: Specify true to update the last-seen timestamp of the recommendation object. ,
Required: False ,
}
boolean ,
recommendationId:
{
Description: The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: RecommendationRule resource specific properties ,
Required: False ,
}
{
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. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: Localized detailed description of the rule. ,
Required: False ,
}
string ,
actionName:
{
Description: Name of action that is recommended by this rule in string. ,
Required: False ,
}
string ,
level:
{
Description: Level of impact indicating how critical this rule is. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Information: No description available. ,
NonUrgentSuggestion: No description available. ,
}
,
Required: False ,
}
enum ,
channels:
{
Description: List of available channels that this rule applies. ,
Enum:
{
Notification: No description available. ,
Api: No description available. ,
Email: No description available. ,
Webhook: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: An array of category tags that the rule contains. ,
Required: False ,
}
[
string ,
]
,
isDynamic:
{
Description: True if this is associated with a dynamically added rule ,
Required: False ,
}
boolean ,
extensionName:
{
Description: Extension name of the portal if exists. Applicable to dynamic rule only. ,
Required: False ,
}
string ,
bladeName:
{
Description: Deep link to a blade on the portal. Applicable to dynamic rule only. ,
Required: False ,
}
string ,
forwardLink:
{
Description: Forward link to an external document associated with the rule. Applicable to dynamic rule only. ,
Required: False ,
}
string ,
}
,
}
Recommendations_DisableRecommendationForSite (removed)
Description :  Disables the specific rule for a web site permanently.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}
ResourceHealthMetadata_List (removed)
Description :  List all ResourceHealthMetadata for all sites in the subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ResourceHealthMetadata_ListByResourceGroup (removed)
Description :  List all ResourceHealthMetadata for all sites in the resource group in the subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ResourceHealthMetadata_ListBySite (removed)
Description :  Gets the category of ResourceHealthMetadata to use for the given site as a collection
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ResourceHealthMetadata_GetBySite (removed)
Description :  Gets the category of ResourceHealthMetadata to use for the given site
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ResourceHealthMetadata_ListBySiteSlot (removed)
Description :  Gets the category of ResourceHealthMetadata to use for the given site as a collection
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ResourceHealthMetadata_GetBySiteSlot (removed)
Description :  Gets the category of ResourceHealthMetadata to use for the given site
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: ResourceHealthMetadata resource specific properties ,
Required: False ,
}
{
category:
{
Description: The category that the resource matches in the RHC Policy File ,
Required: False ,
}
string ,
signalAvailability:
{
Description: Is there a health signal for the resource ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
GetPublishingUser (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:
{
Description: User resource specific properties ,
Required: False ,
}
{
name:
{
Description: Username ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing. ,
Required: True ,
}
string ,
publishingPassword:
{
Description: Password used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHash:
{
Description: Password hash used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHashSalt:
{
Description: Password hash salt used for publishing. ,
Format: password ,
Required: False ,
}
string ,
}
,
}
UpdatePublishingUser (removed)
Description :  Updates publishing user
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: User resource specific properties ,
Required: False ,
}
{
name:
{
Description: Username ,
Required: False ,
}
string ,
publishingUserName:
{
Description: Username used for publishing. ,
Required: True ,
}
string ,
publishingPassword:
{
Description: Password used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHash:
{
Description: Password hash used for publishing. ,
Format: password ,
Required: False ,
}
string ,
publishingPasswordHashSalt:
{
Description: Password hash salt used for publishing. ,
Format: password ,
Required: False ,
}
string ,
}
,
}
ListSourceControls (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: True ,
}
[
{
properties:
{
Description: SourceControl resource specific 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 ,
}
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:
{
Description: SourceControl resource specific 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 ,
}
,
}
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:
{
Description: SourceControl resource specific 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:
{
Description: SourceControl resource specific 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 ,
}
,
}
CheckNameAvailability (removed)
Description :  Check if a resource name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability
{
request:
{
Description: Name availability request. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Enum:
{
Site: No description available. ,
Slot: No description available. ,
HostingEnvironment: No description available. ,
PublishingUser: No description available. ,
Microsoft.Web/sites: No description available. ,
Microsoft.Web/sites/slots: No description available. ,
Microsoft.Web/hostingEnvironments: No description available. ,
Microsoft.Web/publishingUsers: No description available. ,
}
,
Required: True ,
}
enum ,
isFqdn:
{
Description: Is fully qualified domain name. ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: true indicates name is valid and available. false indicates the name is invalid, unavailable, or both. ,
Required: False ,
}
boolean ,
reason:
{
Description: Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name. ,
Required: False ,
}
string ,
}
BillingMeters_List (removed)
Description :  Gets a list of meters for a given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters
{
billingLocation:
{
Description: Azure Location of billable resource ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is 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 Billing Meters. ,
Required: True ,
}
[
{
properties:
{
Description: BillingMeter resource specific properties ,
Required: False ,
}
{
meterId:
{
Description: Meter GUID onboarded in Commerce ,
Required: False ,
}
string ,
billingLocation:
{
Description: Azure Location of billable resource ,
Required: False ,
}
string ,
shortName:
{
Description: Short Name from App Service Azure pricing Page ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of the meter ,
Required: False ,
}
string ,
resourceType:
{
Description: App Service resource type meter used for ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
GetSubscriptionDeploymentLocations (removed)
Description :  Gets list of available geo regions plus ministamps
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions
{
sku:
{
Description: Name of SKU used to filter the regions. ,
Required: False ,
}
string ,
linuxWorkersEnabled:
{
Description: Specify true if you want to filter to only regions that support Linux workers. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: GeoRegion resource specific properties ,
Required: False ,
}
{
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 ,
}
ListSiteIdentifiersAssignedToHostName (removed)
Description :  List all apps that are assigned to a hostname.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/listSitesAssignedToHostName
{
nameIdentifier:
{
Description: Hostname information. ,
Required: True ,
}
{
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Identifier resource specific properties ,
Required: False ,
}
{
id:
{
Description: String representation of the identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
ListPremierAddOnOffers (removed)
Description :  List all premier add-on offers.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: PremierAddOnOffer resource specific properties ,
Required: False ,
}
{
sku:
{
Description: Premier add on SKU. ,
Required: False ,
}
string ,
product:
{
Description: Premier add on offer Product. ,
Required: False ,
}
string ,
vendor:
{
Description: Premier add on offer Vendor. ,
Required: False ,
}
string ,
name:
{
Description: Premier add on offer Name. ,
Required: False ,
}
string ,
promoCodeRequired:
{
Description: true if promotion code is required; otherwise, false. ,
Required: False ,
}
boolean ,
quota:
{
Description: Premier add on offer Quota. ,
Format: int32 ,
Required: False ,
}
integer ,
webHostingPlanRestrictions:
{
Description: App Service plans this offer is restricted to. ,
Enum:
{
None: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
privacyPolicyUrl:
{
Description: Privacy policy URL. ,
Required: False ,
}
string ,
legalTermsUrl:
{
Description: Legal terms URL. ,
Required: False ,
}
string ,
marketplacePublisher:
{
Description: Marketplace publisher. ,
Required: False ,
}
string ,
marketplaceOffer:
{
Description: Marketplace offer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}
ListSkus (removed)
Description :  List all SKUs.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
resourceType:
{
Description: Resource type that this SKU applies to. ,
Required: False ,
}
string ,
skus:
{
Description: List of SKUs the subscription is able to use. ,
Required: False ,
}
[
{
name:
{
Description: Name of the resource SKU. ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource SKU. ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource SKU. ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource SKU. ,
Required: False ,
}
string ,
capacity:
{
Description: Min, max, and default scale values of the SKU. ,
Required: False ,
}
{
minimum:
{
Description: Minimum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Maximum number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default number of workers for this App Service plan SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Available scale configurations for an App Service plan. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: Locations of the SKU. ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: Capabilities of the SKU, e.g., is traffic manager enabled? ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU capability. ,
Required: False ,
}
string ,
value:
{
Description: Value of the SKU capability. ,
Required: False ,
}
string ,
reason:
{
Description: Reason of the SKU capability. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
VerifyHostingEnvironmentVnet (removed)
Description :  Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/verifyHostingEnvironmentVnet
{
parameters:
{
Description: VNET information ,
Required: True ,
}
{
properties:
{
Description: VnetParameters resource specific properties ,
Required: False ,
}
{
vnetResourceGroup:
{
Description: The Resource Group of the VNET to be validated ,
Required: False ,
}
string ,
vnetName:
{
Description: The name of the VNET to be validated ,
Required: False ,
}
string ,
vnetSubnetName:
{
Description: The subnet name to be validated ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VnetValidationFailureDetails resource specific properties ,
Required: False ,
}
{
failed:
{
Description: A flag describing whether or not validation failed. ,
Required: False ,
}
boolean ,
failedTests:
{
Description: A list of tests that failed in the validation. ,
Required: False ,
}
[
{
properties:
{
Description: VnetValidationTestFailure resource specific properties ,
Required: False ,
}
{
testName:
{
Description: The name of the test that failed. ,
Required: False ,
}
string ,
details:
{
Description: The details of what caused the failure, e.g. the blocking rule name, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
Move (removed)
Description :  Move resources between resource groups.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
moveResourceEnvelope:
{
Description: Object that represents the resource to move. ,
Required: True ,
}
{
targetResourceGroup:
{
Required: False ,
}
string ,
resources:
{
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Validate (removed)
Description :  Validate if a resource can be created.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
validateRequest:
{
Description: Request with the resources to validate. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Enum:
{
ServerFarm: No description available. ,
Site: No description available. ,
}
,
Required: True ,
}
enum ,
location:
{
Description: Expected location of the resource. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the resource to validate. ,
Required: True ,
}
{
serverFarmId:
{
Description: ARM resource ID of an App Service plan that would host the app. ,
Required: False ,
}
string ,
skuName:
{
Description: Name of the target SKU for the App Service plan. ,
Required: False ,
}
string ,
needLinuxWorkers:
{
Description: true if App Service plan is for Linux workers; otherwise, false. ,
Required: False ,
}
boolean ,
isSpot:
{
Description: true if App Service plan is for Spot instances; otherwise, false. ,
Required: False ,
}
boolean ,
capacity:
{
Description: Target capacity of the App Service plan (number of VMs). ,
Format: int32 ,
Required: False ,
}
integer ,
hostingEnvironment:
{
Description: Name of App Service Environment where app or App Service plan should be created. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Result of validation. ,
Required: False ,
}
string ,
error:
{
Description: Error details for the case when validation fails. ,
Required: False ,
}
{
code:
{
Description: Validation error code. ,
Required: False ,
}
string ,
message:
{
Description: Validation error message. ,
Required: False ,
}
string ,
}
,
}
ValidateMove (removed)
Description :  Validate whether a resource can be moved.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
moveResourceEnvelope:
{
Description: Object that represents the resource to move. ,
Required: True ,
}
{
targetResourceGroup:
{
Required: False ,
}
string ,
resources:
{
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}