Dps Certificate - Delete

Service:

IoT Hub Device Provisioning Service

API Version:

2022-12-12

Delete the Provisioning Service Certificate.
Deletes the specified certificate associated with the Provisioning Service

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

With optional parameters:

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}?certificate.name={certificate.name}&certificate.rawBytes={certificate.rawBytes}&certificate.isVerified={certificate.isVerified}&certificate.purpose={certificate.purpose}&certificate.created={certificate.created}&certificate.lastUpdated={certificate.lastUpdated}&certificate.hasPrivateKey={certificate.hasPrivateKey}&certificate.nonce={certificate.nonce}&api-version=2022-12-12

URI Parameters

Name	In	Required	Type	Description
certificateName	path	True	string	This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by.
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.
certificate.created	query		string date-time	Time the certificate is created.
certificate.hasPrivateKey	query		boolean	Indicates if the certificate contains a private key.
certificate.isVerified	query		boolean	Indicates if certificate has been verified by owner of the private key.
certificate.lastUpdated	query		string date-time	Time the certificate is last updated.
certificate.name	query		string	This is optional, and it is the Common Name of the certificate.
certificate.nonce	query		string	Random number generated to indicate Proof of Possession.
certificate.purpose	query		CertificatePurpose	A description that mentions the purpose of the certificate.
certificate.rawBytes	query		string byte	Raw data within the certificate.

Request Header

Name	Required	Type	Description
If-Match	True	string	ETag of the certificate

Responses

Name	Type	Description
200 OK		OK.
204 No Content		No content.
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

DPSDeleteCertificate

Sample request

HTTP

DELETE https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/certificates/cert?certificate.name={certificate.name}&certificate.rawBytes={certificate.rawBytes}&certificate.isVerified={certificate.isVerified}&certificate.purpose={certificate.purpose}&certificate.created={certificate.created}&certificate.lastUpdated={certificate.lastUpdated}&certificate.hasPrivateKey={certificate.hasPrivateKey}&certificate.nonce={certificate.nonce}&api-version=2022-12-12

Sample response

Status code:

200

Status code:

204

Definitions

Name	Description
CertificatePurpose	A description that mentions the purpose of the certificate.
ErrorDetails	Error details.

CertificatePurpose

A description that mentions the purpose of the certificate.

Name	Type	Description
clientAuthentication	string
serverAuthentication	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.