Azure IoT Hub
Use this API to manage the IoT hubs in your Azure subscription.
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
Use this API to manage the IoT hubs in your Azure subscription.
Endpoints 38
Operations
- GETOperations_List
/providers/Microsoft.Devices/operationsList the operations for the provider
GET
- GETGet all the IoT hubs in a subscription
/subscriptions/:subscriptionId/providers/Microsoft.Devices/IotHubsGet all the IoT hubs in a subscription. - GETGet the number of iot hubs in the subscription
/subscriptions/:subscriptionId/providers/Microsoft.Devices/usagesGet the number of free and paid iot hubs in the subscription - GETGet all the IoT hubs in a resource group
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubsGet all the IoT hubs in a resource group. - GETGet the non-security related metadata of an IoT hub
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceNameGet the non-security related metadata of an IoT hub. - GETGet the statistics from an IoT hub
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/IotHubStatsGet the statistics from an IoT hub. - GETGet a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/eventHubEndpoints/:eventHubEndpointName/ConsumerGroupsGet a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub. - GETGet a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/eventHubEndpoints/:eventHubEndpointName/ConsumerGroups/:nameGet a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. - GETGet a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/jobsGet a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. - GETGet the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/jobs/:jobIdGet the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. - GETGet the quota metrics for an IoT hub
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/quotaMetricsGet the quota metrics for an IoT hub. - GETGet the health for routing endpoints
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:iotHubName/routingEndpointsHealthGet the health for routing endpoints. - GETGet the list of valid SKUs for an IoT hub
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/skusGet the list of valid SKUs for an IoT hub. - GETList private endpoint connections
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/iotHubs/:resourceName/privateEndpointConnectionsList private endpoint connection properties - GETGet private endpoint connection
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/iotHubs/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameGet private endpoint connection properties - GETList private link resources
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/iotHubs/:resourceName/privateLinkResourcesList private link resources for the given IotHub - GETGet the specified private link resource
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/iotHubs/:resourceName/privateLinkResources/:groupIdGet the specified private link resource for the given IotHub
PUT
- PUTCreate or update the metadata of an IoT hub.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceNameCreate or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then… - PUTAdd a consumer group to an Event Hub-compatible endpoint in an IoT hub
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/eventHubEndpoints/:eventHubEndpointName/ConsumerGroups/:nameAdd a consumer group to an Event Hub-compatible endpoint in an IoT hub. - PUTUpdate private endpoint connection
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/iotHubs/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameUpdate the status of a private endpoint connection with the specified name
PATCH
- PATCHUpdate an existing IoT Hubs tags.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceNameUpdate an existing IoT Hub tags. to update other fields use the CreateOrUpdate method
DELETE
- DELETEDelete an IoT hub
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceNameDelete an IoT hub. - DELETEDelete a consumer group from an Event Hub-compatible endpoint in an IoT hub
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/eventHubEndpoints/:eventHubEndpointName/ConsumerGroups/:nameDelete a consumer group from an Event Hub-compatible endpoint in an IoT hub. - DELETEDelete private endpoint connection
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/iotHubs/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameDelete private endpoint connection with the specified name
POST
- POSTCheck if an IoT hub name is available
/subscriptions/:subscriptionId/providers/Microsoft.Devices/checkNameAvailabilityCheck if an IoT hub name is available. - POSTGet a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/IotHubKeys/:keyName/listkeysGet a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. - POSTExports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/exportDevicesExports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see:… - POSTManually initiate a failover for the IoT Hub to its secondary region
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:iotHubName/failoverManually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover - POSTImport, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/importDevicesImport, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see:… - POSTGet the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/listkeysGet the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. - POSTTest all routes
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:iotHubName/routing/routes/$testallTest all routes configured in this Iot Hub - POSTTest the new route
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:iotHubName/routing/routes/$testnewTest the new route for this Iot Hub
Certificates
- GETGet the certificate list.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificatesReturns the list of certificates. - GETGet the certificate.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates/:certificateNameReturns the certificate. - PUTUpload the certificate to the IoT hub.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates/:certificateNameAdds new or replaces existing certificate. - DELETEDelete an X509 certificate.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates/:certificateNameDeletes an existing X509 certificate or does nothing if it does not exist. - POSTGenerate verification code for proof of possession flow.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates/:certificateName/generateVerificationCodeGenerates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate. - POSTVerify certificate's private key possession.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates/:certificateName/verifyVerifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 38 operations on 29 pathsGET 19POST 10PUT 4DELETE 4PATCH 1
- Main resources
- GET 16POST 8Certificates 6DELETE 3PUT 3Operations 1PATCH 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2026-11-01 - Links
- OpenAPI document
How to test the Azure IoT Hub 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 Azure IoT Hub 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), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure IoT Hub?
Use this API to manage the IoT hubs in your Azure subscription. It is listed under IoT & devices and has 38 endpoints.
Who publishes the Azure IoT Hub?
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 IoT Hub?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure IoT Hub?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure IoT Hub have?
38 operations on 29 paths (19 GET, 10 POST, 4 PUT, 4 DELETE, 1 PATCH). The largest groups are GET, POST, Certificates, DELETE.
Is forking the Azure IoT Hub free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.