Microsoft Azure IoT extension for Azure CLI

The Azure IoT extension for Azure CLI aims to accelerate the development, management and automation of Azure IoT solutions. It does this via addition of rich features and functionality to the official Azure CLI.

News

• ❗ When upgrading your Azure CLI core version, for the best experience and to avoid breaking changes, we recommend updating your azure-iot extension to the latest available.

• Azure CLI 2.24.0 requires an azure-iot extension update to 0.10.11 or later for IoT Hub commands to work properly. However we recommend at least azure-iot 0.10.14. Updating the extension can be done with az extension update --name azure-iot.

Note: A common error that arises when using an older azure-iot with Azure CLI 2.24.0+ shows as follows: AttributeError: 'IotHubResourceOperations' object has no attribute 'config'.

• Starting with version 0.10.13 of the IoT extension, you will need an Azure CLI core version of 2.17.1 or higher. IoT extension version 0.10.11 remains on the extension index to support environments that cannot upgrade core CLI versions.

• The legacy IoT extension Id azure-cli-iot-ext is deprecated in favor of the new modern Id azure-iot. azure-iot is a superset of azure-cli-iot-ext and any new features or fixes will apply to azure-iot only. Also the legacy and modern IoT extension should never co-exist in the same CLI environment.

  Uninstall the legacy extension with the following command: az extension remove --name azure-cli-iot-ext.

  Related - if you see an error with a stacktrace similar to:

  ...
  azure-cli-iot-ext/azext_iot/common/_azure.py, ln 90, in get_iot_hub_connection_string
      client = iot_hub_service_factory(cmd.cli_ctx)
  cliextensions/azure-cli-iot-ext/azext_iot/_factory.py, ln 29, in iot_hub_service_factory
      from azure.mgmt.iothub.iot_hub_client import IotHubClient
  ModuleNotFoundError: No module named 'azure.mgmt.iothub.iot_hub_client'
  

  The resolution is to remove the deprecated azure-cli-iot-ext and install any version of the azure-iot extension.

Commands

Please refer to the official az iot reference on Microsoft Docs for a complete list of supported commands. You can also find IoT CLI usage tips on the wiki.

Installation

1. Install the Azure CLI
   • You must have at least v2.3.1, which you can verify with az --version
2. Add, Update or Remove the IoT extension with the following commands:
   • Add: az extension add --name azure-iot
   • Update: az extension update --name azure-iot
   • Remove: az extension remove --name azure-iot

Please refer to the Installation Troubleshooting Guide if you run into any issues or the Alternative Installation Methods if you'd like to install from a GitHub release or local source.

Usage

After installing the Azure IoT extension your CLI environment is augmented with the addition of hub, central, dps, dt, edge and device commands.

For usage and help content of any command or command group, pass in the -h parameter. Root command group details are shown for the following IoT services.

Click a section to expand or collapse

Digital Twins

$ az dt -h
Group
    az dt : Manage Azure Digital Twins solutions & infrastructure.
        This command group is in preview. It may be changed/removed in a future release.
Subgroups:
    endpoint        : Manage and configure Digital Twins instance endpoints.
    model           : Manage DTDL models and definitions on a Digital Twins instance.
    role-assignment : Manage RBAC role assignments for a Digital Twins instance.
    route           : Manage and configure event routes.
    twin            : Manage and configure the digital twins of a Digital Twins instance.

Commands:
    create          : Create a new Digital Twins instance.
    delete          : Delete an existing Digital Twins instance.
    list            : List the collection of Digital Twins instances by subscription or resource
                      group.
    show            : Show an existing Digital Twins instance.

IoT Central

$ az iot central -h
Group
    az iot central : Manage IoT Central resources.
        IoT Central is an IoT application platform that reduces the burden and cost of developing,
        managing, and maintaining enterprise-grade IoT solutions. Choosing to build with IoT Central
        gives you the opportunity to focus time, money, and energy on transforming your business
        with IoT data, rather than just maintaining and updating a complex and continually evolving
        IoT infrastructure.
        IoT Central documentation is available at https://aka.ms/iotcentral-documentation.

Subgroups:
    api-token       [Preview] : Create and Manage API tokens.
    app                       : Manage IoT Central applications.
    device          [Preview] : Manage and configure IoT Central devices.
    device-template [Preview] : Manage and configure IoT Central device templates.
    diagnostics     [Preview] : Perform application and device level diagnostics.
    user            [Preview] : Manage and configure IoT Central users.

For more specific examples, use: az find "az iot central"

IoT Device Provisioning

$ az iot dps -h
Group
    az iot dps : Manage entities in an Azure IoT Hub Device Provisioning Service. Augmented with the
    IoT extension.

Subgroups:
    access-policy    : Manage Azure IoT Hub Device Provisioning Service access policies.
    certificate      : Manage Azure IoT Hub Device Provisioning Service certificates.
    enrollment       : Manage enrollments in an Azure IoT Hub Device Provisioning Service.
    enrollment-group : Manage Azure IoT Hub Device Provisioning Service.
    linked-hub       : Manage Azure IoT Hub Device Provisioning Service linked IoT hubs.
    registration     : Manage Azure IoT Hub Device Provisioning Service registrations.

Commands:
    create           : Create an Azure IoT Hub device provisioning service.
    delete           : Delete an Azure IoT Hub device provisioning service.
    list             : List Azure IoT Hub device provisioning services.
    show             : Get the details of an Azure IoT Hub device provisioning service.
    update           : Update an Azure IoT Hub device provisioning service.

IoT Edge

$ az iot edge -h
Group
    az iot edge : Manage IoT solutions on the Edge.

Subgroups:
    deployment  : Manage IoT Edge deployments at scale.

Commands:
    set-modules : Set edge modules on a single device.

IoT Hub

$ az iot hub -h
Group
    az iot hub : Manage entities in an Azure IoT Hub.

Subgroups:
    certificate                   : Manage IoT Hub certificates.
    configuration                 : Manage IoT automatic device management configuration at scale.
    connection-string             : Manage IoT Hub connection strings.
    consumer-group                : Manage the event hub consumer groups of an IoT hub.
    device-identity               : Manage IoT devices.
    device-twin                   : Manage IoT device twin configuration.
    devicestream                  : Manage device streams of an IoT hub.
    distributed-tracing [Preview] : Manage distributed settings per-device.
    job                           : Manage IoT Hub jobs (v2).
    message-enrichment            : Manage message enrichments for endpoints of an IoT Hub.
    module-identity               : Manage IoT device modules.
    module-twin                   : Manage IoT device module twin configuration.
    policy                        : Manage shared access policies of an IoT hub.
    route                         : Manage routes of an IoT hub.
    routing-endpoint              : Manage custom endpoints of an IoT hub.

Commands:
    create                        : Create an Azure IoT hub.
    delete                        : Delete an IoT hub.
    generate-sas-token            : Generate a SAS token for a target IoT Hub, device or module.
    invoke-device-method          : Invoke a device method.
    invoke-module-method          : Invoke an Edge module method.
    list                          : List IoT hubs.
    list-skus                     : List available pricing tiers.
    manual-failover               : Initiate a manual failover for the IoT Hub to the geo-paired
                                    disaster recovery region.
    monitor-events                : Monitor device telemetry & messages sent to an IoT Hub.
    monitor-feedback              : Monitor feedback sent by devices to acknowledge cloud-to-device
                                    (C2D) messages.
    query                         : Query an IoT Hub using a powerful SQL-like language.
    show                          : Get the details of an IoT hub.
    show-connection-string        : Show the connection strings for an IoT hub.
    show-quota-metrics            : Get the quota metrics for an IoT hub.
    show-stats                    : Get the statistics for an IoT hub.
    update                        : Update metadata for an IoT hub.

Scenario Automation

Please refer to the Scenario Automation page for examples of how to use the IoT extension in scripts.

Contributing

Please refer to the Contributing page for developer setup instructions and contribution guidelines.

Feedback

We are constantly improving and are always open to new functionality or enhancement ideas. Submit your feedback in the project issues.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.