az iot
Manage Internet of Things (IoT) assets.
Comprehensive IoT data-plane functionality is available in the Azure IoT CLI Extension. For more info and install guide go to https://github.com/Azure/azure-iot-cli-extension.
Commands
az iot central |
Manage IoT Central resources. |
az iot central app |
Manage IoT Central applications. |
az iot central app create |
Create an IoT Central application. |
az iot central app delete |
Delete an IoT Central application. |
az iot central app list |
List IoT Central applications. |
az iot central app show |
Get the details of an IoT Central application. |
az iot central app update |
Update metadata for an IoT Central application. |
az iot dps |
Manage Azure IoT Hub Device Provisioning Service. |
az iot dps access-policy |
Manage Azure IoT Hub Device Provisioning Service access policies. |
az iot dps access-policy create |
Create a new shared access policy in an Azure IoT Hub device provisioning service. |
az iot dps access-policy delete |
Delete a shared access policies in an Azure IoT Hub device provisioning service. |
az iot dps access-policy list |
List all shared access policies in an Azure IoT Hub device provisioning service. |
az iot dps access-policy show |
Show details of a shared access policies in an Azure IoT Hub device provisioning service. |
az iot dps access-policy update |
Update a shared access policy in an Azure IoT Hub device provisioning service. |
az iot dps certificate |
Manage Azure IoT Hub Device Provisioning Service certificates. |
az iot dps certificate create |
Create/upload an Azure IoT Hub Device Provisioning Service certificate. |
az iot dps certificate delete |
Delete an Azure IoT Hub Device Provisioning Service certificate. |
az iot dps certificate generate-verification-code |
Generate a verification code for an Azure IoT Hub Device Provisioning Service certificate. |
az iot dps certificate list |
List all certificates contained within an Azure IoT Hub device provisioning service. |
az iot dps certificate show |
Show information about a particular Azure IoT Hub Device Provisioning Service certificate. |
az iot dps certificate update |
Update an Azure IoT Hub Device Provisioning Service certificate. |
az iot dps certificate verify |
Verify an Azure IoT Hub Device Provisioning Service certificate. |
az iot dps create |
Create an Azure IoT Hub device provisioning service. |
az iot dps delete |
Delete an Azure IoT Hub device provisioning service. |
az iot dps linked-hub |
Manage Azure IoT Hub Device Provisioning Service linked IoT hubs. |
az iot dps linked-hub create |
Create a linked IoT hub in an Azure IoT Hub device provisioning service. |
az iot dps linked-hub delete |
Update a linked IoT hub in an Azure IoT Hub device provisioning service. |
az iot dps linked-hub list |
List all linked IoT hubs in an Azure IoT Hub device provisioning service. |
az iot dps linked-hub show |
Show details of a linked IoT hub in an Azure IoT Hub device provisioning service. |
az iot dps linked-hub update |
Update a linked IoT hub in an Azure IoT Hub device provisioning service. |
az iot dps list |
List Azure IoT Hub device provisioning services. |
az iot dps show |
Get the details of an Azure IoT Hub device provisioning service. |
az iot dps update |
Update an Azure IoT Hub device provisioning service. |
az iot hub |
Manage Azure IoT hubs. |
az iot hub certificate |
Manage IoT Hub certificates. |
az iot hub certificate create |
Create/upload an Azure IoT Hub certificate. |
az iot hub certificate delete |
Deletes an Azure IoT Hub certificate. |
az iot hub certificate generate-verification-code |
Generates a verification code for an Azure IoT Hub certificate. |
az iot hub certificate list |
Lists all certificates contained within an Azure IoT Hub. |
az iot hub certificate show |
Shows information about a particular Azure IoT Hub certificate. |
az iot hub certificate update |
Update an Azure IoT Hub certificate. |
az iot hub certificate verify |
Verifies an Azure IoT Hub certificate. |
az iot hub consumer-group |
Manage the event hub consumer groups of an IoT hub. |
az iot hub consumer-group create |
Create an event hub consumer group. |
az iot hub consumer-group delete |
Delete an event hub consumer group. |
az iot hub consumer-group list |
List event hub consumer groups. |
az iot hub consumer-group show |
Get the details for an event hub consumer group. |
az iot hub create |
Create an Azure IoT hub. |
az iot hub delete |
Delete an IoT hub. |
az iot hub devicestream |
Manage device streams of an IoT hub. |
az iot hub devicestream show |
Get IoT Hub's device streams endpoints. |
az iot hub list |
List IoT hubs. |
az iot hub list-skus |
List available pricing tiers. |
az iot hub manual-failover |
Initiate a manual failover for the IoT Hub to the geo-paired disaster recovery region. |
az iot hub message-enrichment |
Manage message enrichments for endpoints of an IoT Hub. |
az iot hub message-enrichment create |
Create a message enrichment for chosen endpoints in your IoT Hub. |
az iot hub message-enrichment delete |
Delete a message enrichment in your IoT hub (by key). |
az iot hub message-enrichment list |
Get information on all message enrichments for your IoT Hub. |
az iot hub message-enrichment update |
Update a message enrichment in your IoT hub (by key). |
az iot hub policy |
Manage shared access policies of an IoT hub. |
az iot hub policy create |
Create a new shared access policy in an IoT hub. |
az iot hub policy delete |
Delete a shared access policy from an IoT hub. |
az iot hub policy list |
List shared access policies of an IoT hub. |
az iot hub policy renew-key |
Regenerate keys of a shared access policy of an IoT hub. |
az iot hub policy show |
Get the details of a shared access policy of an IoT hub. |
az iot hub route |
Manage routes of an IoT hub. |
az iot hub route create |
Create a route in IoT Hub. |
az iot hub route delete |
Delete all or mentioned route for your IoT Hub. |
az iot hub route list |
Get all the routes in IoT Hub. |
az iot hub route show |
Get information about the route in IoT Hub. |
az iot hub route test |
Test all routes or mentioned route in IoT Hub. |
az iot hub route update |
Update a route in IoT Hub. |
az iot hub routing-endpoint |
Manage custom endpoints of an IoT hub. |
az iot hub routing-endpoint create |
Add an endpoint to your IoT Hub. |
az iot hub routing-endpoint delete |
Delete all or mentioned endpoint for your IoT Hub. |
az iot hub routing-endpoint list |
Get information on all the endpoints for your IoT Hub. |
az iot hub routing-endpoint show |
Get information on mentioned endpoint for your IoT Hub. |
az iot hub show |
Get the details of an IoT hub. |
az iot hub show-connection-string |
Show the connection strings for an IoT hub. |
az iot hub show-quota-metrics |
Get the quota metrics for an IoT hub. |
az iot hub show-stats |
Get the statistics for an IoT hub. |
az iot hub update |
Update metadata for an IoT hub. |
az iot central api-token |
Manage API tokens for your IoT Central application. |
az iot central api-token create |
Generate an API token associated with your IoT Central application. |
az iot central api-token delete |
Delete an API token associated with your IoT Central application. |
az iot central api-token list |
List all API tokens associated with your IoT Central application. |
az iot central api-token show |
Get details for an API token associated with your IoT Central application. |
az iot central device |
Manage and configure IoT Central devices. |
az iot central device command |
Run device commands. |
az iot central device command history |
Get the details for the latest command request and response sent to the device. |
az iot central device command run |
Run a command on a device and view associated response. Does NOT monitor property updates that the command may perform. |
az iot central device compute-device-key |
Generate a derived device SAS key. |
az iot central device create |
Create a device in IoT Central. |
az iot central device delete |
Delete a device from IoT Central. |
az iot central device registration-info |
Get registration info on device(s) from IoT Central. |
az iot central device show |
Get a device from IoT Central. |
az iot central device show-credentials |
Get device credentials from IoT Central. |
az iot central device twin |
Manage IoT Central device twins. |
az iot central device twin show |
Get the device twin from IoT Hub. |
az iot central device-template |
Manage and configure IoT Central device templates. |
az iot central device-template create |
Create a device template in IoT Central. |
az iot central device-template delete |
Delete a device template from IoT Central. |
az iot central device-template show |
Get a device template from IoT Central. |
az iot central diagnostics |
Perform application and device level diagnostics. |
az iot central diagnostics monitor-events |
View device telemetry messages sent to the IoT Central app. |
az iot central diagnostics monitor-properties |
View desired and reported properties sent to/from the IoT Central app. |
az iot central diagnostics registration-summary |
View the registration summary of all the devices in an app. |
az iot central diagnostics validate-messages |
Validate messages sent to the IoT Hub for an IoT Central app. |
az iot central diagnostics validate-properties |
Validate reported properties sent to the IoT Central application. |
az iot central user |
Manage and configure IoT Central users. |
az iot central user create |
Add a user to the application. |
az iot central user delete |
Delete a user from the application. |
az iot central user list |
Get list of users in an application. |
az iot central user show |
Get the details of a user by ID. |
az iot device |
Leverage device-to-cloud and cloud-to-device messaging capabilities. |
az iot device c2d-message |
Cloud-to-device messaging commands. |
az iot device c2d-message abandon |
Abandon a cloud-to-device message. |
az iot device c2d-message complete |
Complete a cloud-to-device message. |
az iot device c2d-message purge |
Purge cloud-to-device message queue for a target device. |
az iot device c2d-message receive |
Receive a cloud-to-device message. |
az iot device c2d-message reject |
Reject or deadletter a cloud-to-device message. |
az iot device c2d-message send |
Send a cloud-to-device message. |
az iot device send-d2c-message |
Send an mqtt device-to-cloud message. The command supports sending messages with application and system properties. |
az iot device simulate |
Simulate a device in an Azure IoT Hub. While the device simulation is running, the device will automatically receive and acknowledge cloud-to-device (c2d) messages. For mqtt simulation, all c2d messages will be acknowledged with completion. For http simulation c2d acknowledgement is based on user selection which can be complete, reject or abandon. Note: The command by default will set content-type to application/json and content-encoding to utf-8. This can be overriden. |
az iot device upload-file |
Upload a local file as a device to a pre-configured blob storage container. |
az iot dps compute-device-key |
Generate a derived device SAS key. |
az iot dps enrollment |
Manage enrollments in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment create |
Create a device enrollment in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment delete |
Delete a device enrollment in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment list |
List device enrollments in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment show |
Get device enrollment details in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment update |
Update a device enrollment in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group |
Manage Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group create |
Create an enrollment group in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group delete |
Delete an enrollment group in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group list |
List enrollments groups in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group show |
Get the details of an enrollment group in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group update |
Update an enrollment group in an Azure IoT Hub Device Provisioning Service. |
az iot dps registration |
Manage Azure IoT Hub Device Provisioning Service registrations. |
az iot dps registration delete |
Delete a device registration in an Azure IoT Hub Device Provisioning Service. |
az iot dps registration list |
List device registration state in an Azure IoT Hub Device Provisioning Service enrollment group. |
az iot dps registration show |
Get the device registration state in an Azure IoT Hub Device Provisioning Service. |
az iot edge |
Manage IoT solutions on the Edge. |
az iot edge deployment |
Manage IoT Edge deployments at scale. |
az iot edge deployment create |
Create an IoT Edge deployment in a target IoT Hub. |
az iot edge deployment delete |
Delete an IoT Edge deployment. |
az iot edge deployment list |
List IoT Edge deployments in an IoT Hub. |
az iot edge deployment show |
Get the details of an IoT Edge deployment. |
az iot edge deployment show-metric |
Evaluate a target system metric defined in an IoT Edge deployment. |
az iot edge deployment update |
Update specified properties of an IoT Edge deployment. Use --set followed by property assignments for updating a deployment. Note: IoT Edge deployment content is immutable. Deployment properties that can be updated are 'labels', 'metrics', 'priority' and 'targetCondition'. |
az iot edge set-modules |
Set edge modules on a single device. |
az iot hub configuration |
Manage IoT automatic device management configuration at scale. |
az iot hub configuration create |
Create an IoT automatic device management configuration in a target IoT Hub. |
az iot hub configuration delete |
Delete an IoT device configuration. |
az iot hub configuration list |
List IoT automatic device management configurations in an IoT Hub. |
az iot hub configuration show |
Get the details of an IoT automatic device management configuration. |
az iot hub configuration show-metric |
Evaluate a target user or system metric defined in an IoT device configuration. |
az iot hub configuration update |
Update specified properties of an IoT automatic device management configuration. Use --set followed by property assignments for updating a configuration. Note: Configuration content is immutable. Configuration properties that can be updated are 'labels', 'metrics', 'priority' and 'targetCondition'. |
az iot hub connection-string |
Manage IoT Hub connection strings. |
az iot hub connection-string show |
Show the connection strings for an IoT Hub. |
az iot hub device-identity |
Manage IoT devices. |
az iot hub device-identity add-children |
Add specified comma-separated list of device ids as children of specified edge device. |
az iot hub device-identity children |
Manage IoT device's children device. |
az iot hub device-identity children add |
Add specified space-separated list of device ids as children of specified edge device. |
az iot hub device-identity children list |
Outputs list of assigned child devices. |
az iot hub device-identity children remove |
Remove devices as children from specified edge device. |
az iot hub device-identity connection-string |
Manage IoT device's connection string. |
az iot hub device-identity connection-string show |
Show a given IoT Hub device connection string. |
az iot hub device-identity create |
Create a device in an IoT Hub. |
az iot hub device-identity delete |
Delete an IoT Hub device. |
az iot hub device-identity export |
Export all device identities from an IoT Hub to an Azure Storage blob container. For inline blob container SAS uri input, please review the input rules of your environment. |
az iot hub device-identity get-parent |
Get the parent device of the specified device. |
az iot hub device-identity import |
Import device identities to an IoT Hub from a blob. For inline blob container SAS uri input, please review the input rules of your environment. |
az iot hub device-identity list |
List devices in an IoT Hub. |
az iot hub device-identity list-children |
Outputs comma-separated list of assigned child devices. |
az iot hub device-identity parent |
Manage IoT device's parent device. |
az iot hub device-identity parent set |
Set the parent device of the specified device. |
az iot hub device-identity parent show |
Get the parent device of the specified device. |
az iot hub device-identity remove-children |
Remove devices as children from specified edge device. |
az iot hub device-identity renew-key |
Renew target keys of an IoT Hub device with sas authentication. |
az iot hub device-identity set-parent |
Set the parent device of the specified device. |
az iot hub device-identity show |
Get the details of an IoT Hub device. |
az iot hub device-identity show-connection-string |
Show a given IoT Hub device connection string. |
az iot hub device-identity update |
Update an IoT Hub device. |
az iot hub device-twin |
Manage IoT device twin configuration. |
az iot hub device-twin replace |
Replace device twin definition with target json. |
az iot hub device-twin show |
Get a device twin definition. |
az iot hub device-twin update |
Update device twin desired properties and tags. |
az iot hub digital-twin |
Manipulate and interact with the digital twin of an IoT Hub device. |
az iot hub digital-twin invoke-command |
Invoke a root or component level command of a digital twin device. |
az iot hub digital-twin show |
Show the digital twin of an IoT Hub device. |
az iot hub digital-twin update |
Update the read-write properties of a digital twin device via JSON patch specification. |
az iot hub distributed-tracing |
Manage distributed settings per-device. |
az iot hub distributed-tracing show |
Get the distributed tracing settings for a device. |
az iot hub distributed-tracing update |
Update the distributed tracing options for a device. |
az iot hub generate-sas-token |
Generate a SAS token for a target IoT Hub, device or module. |
az iot hub invoke-device-method |
Invoke a device method. |
az iot hub invoke-module-method |
Invoke an Edge module method. |
az iot hub job |
Manage IoT Hub jobs (v2). |
az iot hub job cancel |
Cancel an IoT Hub job. |
az iot hub job create |
Create and schedule an IoT Hub job for execution. |
az iot hub job list |
List the historical jobs of an IoT Hub. |
az iot hub job show |
Show details of an existing IoT Hub job. |
az iot hub module-identity |
Manage IoT device modules. |
az iot hub module-identity connection-string |
Manage IoT device module's connection string. |
az iot hub module-identity connection-string show |
Show a target IoT device module connection string. |
az iot hub module-identity create |
Create a module on a target IoT device in an IoT Hub. |
az iot hub module-identity delete |
Delete a device in an IoT Hub. |
az iot hub module-identity list |
List modules located on an IoT device in an IoT Hub. |
az iot hub module-identity show |
Get the details of an IoT device module in an IoT Hub. |
az iot hub module-identity show-connection-string |
Show a target IoT device module connection string. |
az iot hub module-identity update |
Update an IoT Hub device module. |
az iot hub module-twin |
Manage IoT device module twin configuration. |
az iot hub module-twin replace |
Replace a module twin definition with target json. |
az iot hub module-twin show |
Show a module twin definition. |
az iot hub module-twin update |
Update module twin desired properties and tags. |
az iot hub monitor-events |
Monitor device telemetry & messages sent to an IoT Hub. |
az iot hub monitor-feedback |
Monitor feedback sent by devices to acknowledge cloud-to-device (C2D) messages. |
az iot hub query |
Query an IoT Hub using a powerful SQL-like language. |
az iot product |
Manage device testing for product certification. |
az iot product requirement |
Manage product certification requirements. |
az iot product requirement list |
Discover information about provisioning attestation methods that are supported for each badge type. |
az iot product test |
Manage device tests for product certification. |
az iot product test case |
Manage product testing certification test cases. |
az iot product test case list |
List the test cases of a product certification test. |
az iot product test case update |
Update the product certification test case data. |
az iot product test create |
Create a new product test for product certification. |
az iot product test run |
Manage product testing certification test runs. |
az iot product test run show |
Show the status of a testing run. |
az iot product test run submit |
Submit a completed test run to the partner/product service. |
az iot product test search |
Search product repository for testing data. |
az iot product test show |
View product test data. |
az iot product test task |
Manage product testing certification tasks. |
az iot product test task create |
Queue a new testing task. Only one testing task can be running at a time. |
az iot product test task delete |
Cancel a running task matching the specified --task-id. |
az iot product test task show |
Show the status of a testing task. Use --running for current running task or --task-id. |
az iot product test update |
Update the product certification test data. |