Microsoft.CertificateRegistration (stable:2024-11-01)

2025/05/15 • 23 new methods

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_ListByResourceGroup (new)
Description :  Description for Get certificate orders in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_CreateOrUpdate (new)
Description :  Description for Create or update a certificate purchase order.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_Delete (new)
Description :  Description for Delete an existing certificate order.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_Update (new)
Description :  Description for Create or update a certificate purchase order.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_ListCertificates (new)
Description :  Description for List all certificates associated with a certificate order.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_GetCertificate (new)
Description :  Description for Get the certificate associated with a certificate order.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_CreateOrUpdateCertificate (new)
Description :  Description for Creates or updates a certificate and associates with key vault secret.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
keyVaultCertificate:
{
Description: Key vault certificate resource Id. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_DeleteCertificate (new)
Description :  Description for Delete the certificate associated with a certificate order.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_UpdateCertificate (new)
Description :  Description for Creates or updates a certificate and associates with key vault secret.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
name:
{
Description: Name of the certificate. ,
Required: True ,
}
string ,
keyVaultCertificate:
{
Description: Key vault certificate resource Id. ,
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
keyVaultId:
{
Description: Key Vault resource Id. ,
Required: False ,
}
string ,
keyVaultSecretName:
{
Description: Key Vault secret name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of the Key Vault secret. ,
Enum:
{
Initialized: No description available. ,
WaitingOnCertificateOrder: No description available. ,
Succeeded: No description available. ,
CertificateOrderFailed: No description available. ,
OperationNotPermittedOnKeyVault: No description available. ,
AzureServiceUnauthorizedToAccessKeyVault: No description available. ,
KeyVaultDoesNotExist: No description available. ,
KeyVaultSecretDoesNotExist: No description available. ,
UnknownError: No description available. ,
ExternalPrivateKey: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_Reissue (new)
Description :  Description for Reissue an existing certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/reissue
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
reissueCertificateOrderRequest:
{
Description: Parameters for the reissue. ,
Required: True ,
}
{
properties:
{
Description: ReissueCertificateOrderRequest resource specific properties ,
Required: False ,
}
{
keySize:
{
Description: Certificate Key Size. ,
Format: int32 ,
Required: False ,
}
integer ,
delayExistingRevokeInHours:
{
Description: Delay in hours to revoke existing certificate after the new certificate is issued. ,
Format: int32 ,
Required: False ,
}
integer ,
csr:
{
Description: Csr to be used for re-key operation. ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: Should we change the ASC type (from managed private key to external private key and vice versa). ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_Renew (new)
Description :  Description for Renew an existing certificate order.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/renew
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
renewCertificateOrderRequest:
{
Description: Renew parameters ,
Required: True ,
}
{
properties:
{
Description: RenewCertificateOrderRequest resource specific properties ,
Required: False ,
}
{
keySize:
{
Description: Certificate Key Size. ,
Format: int32 ,
Required: False ,
}
integer ,
csr:
{
Description: Csr to be used for re-key operation. ,
Required: False ,
}
string ,
isPrivateKeyExternal:
{
Description: Should we change the ASC type (from managed private key to external private key and vice versa). ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_ResendRequestEmails (new)
Description :  Resend domain verification ownership email containing steps on how to verify a domain for a given certificate order
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_RetrieveSiteSeal (new)
Description :  This method is used to obtain the site seal information for an issued certificate. A site seal is a graphic that the certificate purchaser can embed on their web site to show their visitors information about their SSL certificate. If a web site visitor clicks on the site seal image, a pop-up page is displayed that contains detailed information about the SSL certificate. The site seal token is used to link the site seal graphic image to the appropriate certificate details pop-up page display when a user clicks on the site seal. The site seal images are expected to be static images and hosted by the reseller, to minimize delays for customer page load times.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/retrieveSiteSeal
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: Name of the certificate order. ,
Required: True ,
}
string ,
siteSealRequest:
{
Description: Site seal request. ,
Required: True ,
}
{
lightTheme:
{
Description: If true use the light color theme for site seal; otherwise, use the default color theme. ,
Required: False ,
}
boolean ,
locale:
{
Description: Locale of site seal. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
html:
{
Description: HTML snippet ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_VerifyDomainOwnership (new)
Description :  Description for Verify domain ownership for this certificate order.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppServiceCertificateOrders_RetrieveCertificateActions (new)
Description :  Description for Retrieve the list of certificate actions.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
actionType:
{
Description: Action type. ,
Enum:
{
CertificateIssued: No description available. ,
CertificateOrderCanceled: No description available. ,
CertificateOrderCreated: No description available. ,
CertificateRevoked: No description available. ,
DomainValidationComplete: No description available. ,
FraudDetected: No description available. ,
OrgNameChange: No description available. ,
OrgValidationComplete: No description available. ,
SanDrop: No description available. ,
FraudCleared: No description available. ,
CertificateExpired: No description available. ,
CertificateExpirationWarning: No description available. ,
FraudDocumentationRequired: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: Time at which the certificate action was performed. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
emailId:
{
Description: Email id. ,
Required: False ,
}
string ,
timeStamp:
{
Description: Time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
CertificateOrdersDiagnostics_ListAppServiceCertificateOrderDetectorResponse (new)
Description :  Description for Microsoft.CertificateRegistration to get the list of detectors for this RP.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
CertificateOrdersDiagnostics_GetAppServiceCertificateOrderDetectorResponse (new)
Description :  Description for Microsoft.CertificateRegistration call to get a detector response from App Lens.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/detectors/{detectorName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
certificateOrderName:
{
Description: The certificate order name for which the response is needed. ,
Required: True ,
}
string ,
detectorName:
{
Description: The detector name which needs to be run. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time for detector response. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the detector response. ,
Format: date-time ,
Required: False ,
}
string ,
timeGrain:
{
Description: The time grain for the detector response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
CertificateRegistrationProvider_ListOperations (new)
Description :  Description for Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Required: False ,
}
string ,
isDataAction:
{
Required: False ,
}
boolean ,
display:
{
Description: Meta data about operation used for display in portal. ,
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
operation:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
origin:
{
Required: False ,
}
string ,
properties:
{
Description: Properties available for a Microsoft.Web resource provider operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Resource metrics service provided by Microsoft.Insights resource provider. ,
Required: False ,
}
{
metricSpecifications:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
displayDescription:
{
Required: False ,
}
string ,
unit:
{
Required: False ,
}
string ,
aggregationType:
{
Required: False ,
}
string ,
supportsInstanceLevelAggregation:
{
Required: False ,
}
boolean ,
enableRegionalMdmAccount:
{
Required: False ,
}
boolean ,
sourceMdmAccount:
{
Required: False ,
}
string ,
sourceMdmNamespace:
{
Required: False ,
}
string ,
metricFilterPattern:
{
Required: False ,
}
string ,
fillGapWithZero:
{
Required: False ,
}
boolean ,
isInternal:
{
Required: False ,
}
boolean ,
dimensions:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
internalName:
{
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Required: False ,
}
boolean ,
}
,
]
,
category:
{
Required: False ,
}
string ,
availabilities:
{
Required: False ,
}
[
{
timeGrain:
{
Required: False ,
}
string ,
blobDuration:
{
Required: False ,
}
string ,
}
,
]
,
supportedTimeGrainTypes:
{
Required: False ,
}
[
string ,
]
,
supportedAggregationTypes:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
logSpecifications:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
blobDuration:
{
Required: False ,
}
string ,
logFilterPattern:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}