Dps Certificate - Create Or Update

Service:

IoT Hub Device Provisioning Service

API Version:

2022-12-12

Upload the certificate to the provisioning service.
Add new certificate or update an existing certificate.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}?api-version=2022-12-12

URI Parameters

Name	In	Required	Type	Description
certificateName	path	True	string	The name of the certificate create or update.
provisioningServiceName	path	True	string	The name of the provisioning service.
resourceGroupName	path	True	string	Resource group identifier.
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The version of the API.

Request Header

Name	Required	Type	Description
If-Match		string	ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.

Request Body

Name	Type	Description
properties	CertificateProperties	properties of a certificate

Responses

Name	Type	Description
200 OK	CertificateResponse	If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK).
Other Status Codes	ErrorDetails	Default error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

DPSCreateOrUpdateCertificate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/certificates/cert?api-version=2022-12-12

{
  "properties": {
    "certificate": "MA=="
  }
}

Sample Response

Status code:

200

{
  "properties": {
    "subject": "CN=testdevice1",
    "expiry": "Sat, 31 Dec 2039 23:59:59 GMT",
    "certificate": "MA==",
    "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25",
    "isVerified": false,
    "created": "Thu, 12 Oct 2017 19:23:50 GMT",
    "updated": "Thu, 12 Oct 2017 19:23:50 GMT"
  },
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert",
  "name": "cert",
  "type": "Microsoft.Devices/ProvisioningServices/Certificates",
  "etag": "AAAAAAExpNs="
}

Definitions

Name	Description
CertificateProperties	The description of an X509 CA Certificate.
CertificateResponse	The X509 Certificate.
createdByType	The type of identity that created the resource.
ErrorDetails	Error details.
systemData	Metadata pertaining to creation and last modification of the resource.

CertificateProperties

The description of an X509 CA Certificate.

Name	Type	Description
certificate	string	base-64 representation of X509 certificate .cer file or just .pem file content.
created	string	The certificate's creation date and time.
expiry	string	The certificate's expiration date and time.
isVerified	boolean	Determines whether certificate has been verified.
subject	string	The certificate's subject name.
thumbprint	string	The certificate's thumbprint.
updated	string	The certificate's last update date and time.

CertificateResponse

The X509 Certificate.

Name	Type	Description
etag	string	The entity tag.
id	string	The resource identifier.
name	string	The name of the certificate.
properties	CertificateProperties	properties of a certificate
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	The resource type.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Error details.

Name	Type	Description
code	integer	The error code.
details	string	The error details.
httpStatusCode	string	The HTTP status code.
message	string	The error message.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.