iotDpsClient
API for using the Azure IoT Hub Device Provisioning Service features.
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 18
Operations
- GETOperations_List
/providers/Microsoft.Devices/operations?api-version=stringLists all of the available Microsoft.Devices REST API operations.
POST
- POSTCheck if a provisioning service name is available.
/subscriptions/:subscriptionId/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=stringCheck if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable - 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=string&api-version=stringGenerate verification code for Proof of Possession. - POSTVerify certificate's private key possession.
/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=string&api-version=stringVerifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate. - POSTGet a shared access policy by name from a provisioning service.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/keys/:keyName/listkeys?api-version=stringList primary and secondary keys for a specific key name - POSTGet the security metadata for a provisioning service.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/listkeys?api-version=stringList the primary and secondary keys for a provisioning service.
GET
- GETGet all the provisioning services in a subscription.
/subscriptions/:subscriptionId/providers/Microsoft.Devices/provisioningServices?api-version=stringList all the provisioning services for a given subscription id. - GETIotDpsResource_ListByResourceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices?api-version=stringGet a list of all provisioning services in the given resource group. - GETGet the non-security related metadata of the provisioning service.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName?api-version=stringGet the metadata of the provisioning service without SAS keys. - GETDpsCertificates_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/certificates?api-version=stringGet all the certificates tied to the provisioning service. - GETDpsCertificate_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/certificates/:certificateName?api-version=stringGet the certificate from the provisioning service. - GETIotDpsResource_GetOperationResult
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/operationresults/:operationId?asyncinfo=true&api-version=stringGets the status of a long running operation, such as create, update or delete a provisioning service. - GETGet the list of valid SKUs for a provisioning service.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/skus?api-version=stringGets the list of valid SKUs and tiers for a provisioning service.
PUT
- PUTCreate or update the metadata of the provisioning service.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName?api-version=stringCreate or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and… - PUTUpload the certificate to the provisioning service.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName/certificates/:certificateName?api-version=stringAdd new certificate or update an existing certificate.
DELETE
- DELETEDelete the Provisioning Service
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName?api-version=stringDeletes the Provisioning Service. - DELETEDelete the Provisioning Service Certificate.
/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=string&api-version=stringDeletes the specified certificate assosciated with the Provisioning Service
PATCH
- PATCHUpdate an existing provisioning service's tags.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/provisioningServices/:provisioningServiceName?api-version=stringUpdate an existing provisioning service's tags. to update other fields use the CreateOrUpdate method
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 18 operations on 13 pathsGET 8POST 5PUT 2DELETE 2PATCH 1
- Main resources
- GET 7POST 5DELETE 2PUT 2Operations 1PATCH 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2017-11-15 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the iotDpsClient in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the iotDpsClient collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.Devices/operations?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the iotDpsClient?
API for using the Azure IoT Hub Device Provisioning Service features. It is listed under Developer tools and has 18 endpoints.
Who publishes the iotDpsClient?
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 iotDpsClient?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the iotDpsClient?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the iotDpsClient have?
18 operations on 13 paths (8 GET, 5 POST, 2 PUT, 2 DELETE, 1 PATCH). The largest groups are GET, POST, DELETE, PUT.
Is forking the iotDpsClient free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.