Microsoft Azure

Azure Deviceprovisioningservices

API for using the Azure IoT Hub Device Provisioning Service features.

IoT & devices#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

API for using the Azure IoT Hub Device Provisioning Service features.

Endpoints 24

Operations

  • GETOperations_List/providers/Microsoft.Devices/operationsList the operations for the provider

CertificateResponses

  • GETDpsCertificate_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/certificatesGet all the certificates tied to the provisioning service.
  • GETDpsCertificate_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/certificates/:certificateNameGet the certificate from the provisioning service.
  • PUTDpsCertificate_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/certificates/:certificateNameAdd new certificate or update an existing certificate.
  • DELETEDpsCertificate_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/certificates/:certificateName?certificate.name=string&certificate.rawBytes=c3dhc3Rpaw==&certificate.isVerified=true&certificate.purpose=clientAuthentication&certificate.created=2024-01-01T00:00:00Z&certificate.lastUpdated=2024-01-01T00:00:00Z&certificate.hasPrivateKey=true&certificate.nonce=stringDeletes the specified certificate associated with the Provisioning Service
  • POSTDpsCertificate_GenerateVerificationCode/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/certificates/:certificateName/generateVerificationCode?certificate.name=string&certificate.rawBytes=c3dhc3Rpaw==&certificate.isVerified=true&certificate.purpose=clientAuthentication&certificate.created=2024-01-01T00:00:00Z&certificate.lastUpdated=2024-01-01T00:00:00Z&certificate.hasPrivateKey=true&certificate.nonce=stringGenerate verification code for Proof of Possession.
  • POSTDpsCertificate_VerifyCertificate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/certificates/:certificateName/verify?certificate.name=string&certificate.rawBytes=c3dhc3Rpaw==&certificate.isVerified=true&certificate.purpose=clientAuthentication&certificate.created=2024-01-01T00:00:00Z&certificate.lastUpdated=2024-01-01T00:00:00Z&certificate.hasPrivateKey=true&certificate.nonce=stringVerifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

ProvisioningServiceDescriptions

  • GETIotDpsResource_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.Devices/provisioningServicesList all the provisioning services for a given subscription id.
  • GETIotDpsResource_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServicesGet a list of all provisioning services in the given resource group.
  • GETIotDpsResource_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceNameGet the metadata of the provisioning service without SAS keys.
  • PUTIotDpsResource_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceNameCreate or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and…
  • DELETEIotDpsResource_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceNameDeletes the Provisioning Service.
  • PATCHIotDpsResource_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceNameUpdate an existing provisioning service's tags. to update other fields use the CreateOrUpdate method
  • POSTIotDpsResource_ListKeysForKeyName/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/keys/:keyName/listkeysList primary and secondary keys for a specific key name
  • POSTIotDpsResource_ListKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/listkeysList the primary and secondary keys for a provisioning service.
  • GETIotDpsResource_listValidSkus/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/skusGets the list of valid SKUs and tiers for a provisioning service.

GroupIdInformations

  • GETIotDpsResource_ListPrivateLinkResources/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:resourceName/privateLinkResourcesList private link resources for the given provisioning service
  • GETIotDpsResource_GetPrivateLinkResources/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:resourceName/privateLinkResources/:groupIdGet the specified private link resource for the given provisioning service

PrivateEndpointConnections

  • GETIotDpsResource_ListPrivateEndpointConnections/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:resourceName/privateEndpointConnectionsList private endpoint connection properties
  • GETIotDpsResource_GetPrivateEndpointConnection/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameGet private endpoint connection properties
  • PUTIotDpsResource_CreateOrUpdatePrivateEndpointConnection/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameCreate or update the status of a private endpoint connection with the specified name
  • DELETEIotDpsResource_DeletePrivateEndpointConnection/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameDelete private endpoint connection with the specified name
  • POSTCheck if a provisioning service name is available./subscriptions/:subscriptionId/providers/Microsoft.Devices/checkProvisioningServiceNameAvailabilityCheck if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable
  • GETIotDpsResource_GetOperationResult/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/operationresults/:operationId?asyncinfo=trueGets the status of a long running operation, such as create, update or delete a provisioning service.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
24 operations on 17 pathsGET 12POST 5PUT 3DELETE 3PATCH 1
Main resources
ProvisioningServiceDescriptions 9CertificateResponses 6PrivateEndpointConnections 4GroupIdInformations 2Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2026-11-01

How to test the Azure Deviceprovisioningservices in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Deviceprovisioningservices collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.Devices/operations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Deviceprovisioningservices?

API for using the Azure IoT Hub Device Provisioning Service features. It is listed under IoT & devices and has 24 endpoints.

Who publishes the Azure Deviceprovisioningservices?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Deviceprovisioningservices?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Deviceprovisioningservices?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Deviceprovisioningservices have?

24 operations on 17 paths (12 GET, 5 POST, 3 PUT, 3 DELETE, 1 PATCH). The largest groups are ProvisioningServiceDescriptions, CertificateResponses, PrivateEndpointConnections, GroupIdInformations.

Is forking the Azure Deviceprovisioningservices free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.