Microsoft.Devices (preview:2025-02-01)

2025/07/23 • 3 updated methods

DpsCertificate_Delete (updated)
Description :  Deletes the specified certificate associated with the Provisioning Service
Reference :  Link ¶

⚶ Changes

{
  "#id": "DpsCertificate_Delete",
  "$parameters": [
    {
      "#name": "certificate.lastUpdated",
      "Description": {
        "new": "Certificate last updated time.",
        "old": "Time the certificate is last updated."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate to retrieve. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate ,
Required: True ,
}
string ,
certificate.name:
{
Description: This is optional, and it is the Common Name of the certificate. ,
Required: False ,
}
string ,
certificate.rawBytes:
{
Description: Raw data within the certificate. ,
Format: byte ,
Required: False ,
}
string ,
certificate.isVerified:
{
Description: Indicates if certificate has been verified by owner of the private key. ,
Required: False ,
}
boolean ,
certificate.purpose:
{
Description: A description that mentions the purpose of the certificate. ,
Required: False ,
}
string ,
certificate.created:
{
Description: Time the certificate is created. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.lastUpdated:
{
Description: Certificate last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.hasPrivateKey:
{
Description: Indicates if the certificate contains a private key. ,
Required: False ,
}
boolean ,
certificate.nonce:
{
Description: Random number generated to indicate Proof of Possession. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
DpsCertificate_GenerateVerificationCode (updated)
Description :  Generate verification code for Proof of Possession.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DpsCertificate_GenerateVerificationCode",
  "$parameters": [
    {
      "#name": "certificate.created",
      "Description": {
        "new": "Time the certificate is created.",
        "old": "Certificate creation time."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate to retrieve. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate. ,
Required: True ,
}
string ,
certificate.name:
{
Description: Common Name for the certificate. ,
Required: False ,
}
string ,
certificate.rawBytes:
{
Description: Raw data of certificate. ,
Format: byte ,
Required: False ,
}
string ,
certificate.isVerified:
{
Description: Indicates if the certificate has been verified by owner of the private key. ,
Required: False ,
}
boolean ,
certificate.purpose:
{
Description: Description mentioning the purpose of the certificate. ,
Required: False ,
}
string ,
certificate.created:
{
Description: Time the certificate is created. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.lastUpdated:
{
Description: Certificate last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.hasPrivateKey:
{
Description: Indicates if the certificate contains private key. ,
Required: False ,
}
boolean ,
certificate.nonce:
{
Description: Random number generated to indicate Proof of Possession. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of certificate. ,
Required: False ,
}
string ,
etag:
{
Description: Request etag. ,
Required: False ,
}
string ,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
verificationCode:
{
Description: Verification code. ,
Required: False ,
}
string ,
subject:
{
Description: Certificate subject. ,
Required: False ,
}
string ,
expiry:
{
Description: Code expiry. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Indicate if the certificate is verified by owner of private key. ,
Required: False ,
}
boolean ,
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Format: byte ,
Required: False ,
}
string ,
created:
{
Description: Certificate created time. ,
Required: False ,
}
string ,
updated:
{
Description: Certificate updated time. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
DpsCertificate_VerifyCertificate (updated)
Description :  Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DpsCertificate_VerifyCertificate",
  "$parameters": [
    {
      "#name": "certificate.created",
      "Description": {
        "new": "Time the certificate is created.",
        "old": "Certificate creation time."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
provisioningServiceName:
{
Description: Name of the provisioning service to retrieve. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the certificate to retrieve. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the certificate. ,
Required: True ,
}
string ,
certificate.name:
{
Description: Common Name for the certificate. ,
Required: False ,
}
string ,
certificate.rawBytes:
{
Description: Raw data of certificate. ,
Format: byte ,
Required: False ,
}
string ,
certificate.isVerified:
{
Description: Indicates if the certificate has been verified by owner of the private key. ,
Required: False ,
}
boolean ,
certificate.purpose:
{
Description: Describe the purpose of the certificate. ,
Required: False ,
}
string ,
certificate.created:
{
Description: Time the certificate is created. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.lastUpdated:
{
Description: Certificate last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
certificate.hasPrivateKey:
{
Description: Indicates if the certificate contains private key. ,
Required: False ,
}
boolean ,
certificate.nonce:
{
Description: Random number generated to indicate Proof of Possession. ,
Required: False ,
}
string ,
request:
{
Description: The name of the certificate ,
Required: True ,
}
{
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: properties of a certificate ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Format: byte ,
Required: False ,
}
string ,
created:
{
Description: The certificate's creation date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Format: int32 ,
Required: False ,
}
integer ,
httpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}