azure-iot-cli-extension

General updates

• Fixes issue preventing reference docgen.

Device Update

• The in preview az iot device-update command group is now always available.
  No environment variable is needed for activation.

  • The Device Update command group supports all account and instance related functionality against
    control plane API version 2022-04-01-preview.

Digital Twin updates

• Updated az dt model create command to process input ontologies larger than 250 models in a single command run.
  Size of input ontology is only constrained by the maximum number of models(default 10000) a DT instance can store.

IoT Central updates

• Add support for device groups CRUD.

  • az iot central device-group
    • az iot central device-group list
    • az iot central device-group show
    • az iot central device-group create
    • az iot central device-group delete
    • az iot central device-group update

• Add support for device attestation CRUD.

  • az iot central device attestation
    • az iot central device attestation show
    • az iot central device attestation create
    • az iot central device attestation delete
    • az iot central device attestation update

• Add support for device/module properties/telemetry/command.

  • az iot central device list-components
  • az iot central device list-modules
  • az iot central device telemetry
    • az iot central device telemetry show
  • az iot central device twin
    • az iot central device twin show
    • az iot central device twin update
    • az iot central device twin replace

• Add support for 2022-05-31 GA version.

  • az iot central api-token
  • az iot central device-template
  • az iot central device-group
  • az iot central device
  • az iot central file-upload-config
  • az iot central organization
  • az iot central role
  • az iot central user

IoT device updates

• az iot device simulate and az iot device send-d2c-message support a --model-id argument.
  The model Id is used by a device to advertise the digital twin interface it implements.

General updates

• Dropped support for Python 3.6. The IoT extension is constrained to Python 3.7 or greater.
  If for whatever reason you cannot upgrade from 3.6 you are able to use older extension versions.

Azure Device Update

• Introducing the Azure Device Update for IoT Hub root command group az iot device-update.
  To learn more about the service visit https://docs.microsoft.com/en-us/azure/iot-hub-device-update/.

  • This command group is behind a feature flag environment variable. Set IOT_CLI_ADU_ENABLED to any value
    to activate the command group.
  • The Device Update command group supports all account and instance related functionality.

IoT device updates

• Added device registration commands, az iot device registration create to register a device to an individual
  enrollment or an enrollment group. Currently, devices with symmetric key and x509 certificate authentication
  are supported. Once registered, the device will show up in the linked IoT Hub and can be interacted with or
  simulated using other az iot device commands.

• Added support for simulating device identities that use x509 thumbprint or CA authentication, impacting the
  following commands:

  • az iot device simulate
  • az iot device send-d2c-message

Digital Twin updates

• Added az dt job import preview command group, which will allow users to create and manage jobs for bulk importing
  models, twins and relationships to a Digital Twins instance. The bulk import data must be stored as a blob in
  a user owned storage account and container.

• Data History commands, under the az dt data-history command group, are now GA.

IoT Hub updates

• Updated creation for self-signed certificates to use the Cryptography library instead of the PyOpenSSL library.

IoT DPS updates

• Added registration commands for individual enrollment groups:

  • az iot dps enrollment registration show
  • az iot dps enrollment registration delete

IoT Device Certification

• Updated service API endpoint to vNext URL.

General updates

• The generic CLIErrors raised across the extension have been changed to more specific semantically correct exceptions aligning with CLI core.
• Fix for issue #475 resolving sys.excepthook upon terminating monitor-events process in Py 3.9+ environments [IoT Hub, IoT Central].

Digital Twins updates

• Added optional --telemetry-source-time parameter to az dt twin telemetry send to allow users to
  add a custom timestamp to the sent telemetry.

• Updated both controlplane and dataplane SDKs to now use the newer 2021-06-30-preview API version.

• Added --no-wait parameter to the following operations:

  • az dt create
  • az dt endpoint create
  • az dt private-endpoint create

• Added az dt data-history command group, which will allow users to configure a data history connection
  for a Digital Twins instance using an Event Hub and Azure Data Explorer database. Once configured,
  changes to the Digital Twins instance can be seen in the Azure Data Explorer database.

IoT Central updates

• Added commands for Edge devices and modules:

  • az iot central device edge module

    • az iot central device edge module list
    • az iot central device edge module restart
    • az iot central device edge module show

  • az iot central device edge manifest

    • az iot central device edge manifest show

  • az iot central device edge children

    • az iot central device edge children list
    • az iot central device edge children add
    • az iot central device edge children remove

IoT DPS updates

• Reorganizing command structure for enrollment-group commands:
  • az iot dps compute-device-key is deprecated use az iot dps enrollment-group compute-device-key instead.
  • az iot dps registration is deprecated use az iot dps enrollment-group registration instead.
  • az iot dps registration delete is deprecated use az iot dps enrollment-group registration delete instead.
  • az iot dps registration list is deprecated use az iot dps enrollment-group registration list instead.
  • az iot dps registration show is deprecated use az iot dps enrollment-group registration show instead.

IoT Central updates

• Added missing "update" sub-commands for all commands supporting it:

  • az iot central device update
  • az iot central device-template update
  • az iot central file-upload-config update
  • az iot central organization update
  • az iot central user update

• Added "compact" mode for az iot central device-template list command:
  When "-c" flag is passed, only Ids, display names and model types will be shown for the templates in the application.

• Added az iot central device c2d-message purge to purge cloud-to-device message queue

IoT DPS updates

• Added RBAC support for DPS dataplane commands, similar to the RBAC support for IoT Hub.
  The type of auth used to execute commands can be controlled with the "--auth-type" parameter
  which accepts the values "key" or "login". The value of "key" is set by default.

  • When "--auth-type" has the value of "key", like before the CLI will auto-discover
    a suitable policy when interacting with DPS.

  • When "--auth-type" has the value "login", an access token from the Azure CLI logged in principal
    will be used for the operation.

  • The following commands currently support --auth-type:

    • az iot dps enrollment
    • az iot dps enrollment-group
    • az iot dps registration

• Update DPS dataplane SDK to use the newer 2021-10-01 API version. Most command
  functionality has not changed. Updated commands include:

  • az iot dps enrollment create and az iot dps enrollment update support
    optional device information via --device-info

IoT DPS updates

• Resolves issue where usage of --login with connection string still required az login.

General Updates

• The IoT extension officially supports Python 3.10.

IoT Central updates

• Fixed iot hub token leak for device twin show.

• Adds new preview commands (v1.1-preview)

  • Query (az iot central query)
  • Destination (az iot central export destination)
  • Export (az iot central export)

IoT DPS updates

• Added az iot dps connection-string show to show the DPS connection string with
  similar support as the IoT Hub connection string show.

• DPS supports connection string as a resource identifier with the --login or -l
  parameter, similar to IoT Hub Identifier Arguments.

• DPS now supports auto resource and policy discovery. Resource group is no longer a
  required parameter for az iot dps instance interaction commands. Auto policy discovery ensures
  that a policy with all the correct permissions is available and is used by the IoT
  extension for all DPS operations.

• az iot dps compute-device-key now supports enrollment group identifiers in addition to
  enrollment group symmetric key. Please take a look at the --help docs for functionality
  and usage highlights.

• Improvements to help documentation for DPS functions.

IoT Hub updates

• az iot hub device-identity create supports a device scope argument via --device-scope parameter.

IoT Central updates

• Adds preview commands (v1.1-preview):

  • Organizations (az iot central organization)
  • File Upload Configuration (az iot central file-upload-config)
  • Jobs (az iot central job)

• Adds x-ms-client-request-id header for each request

Breaking Changes

• List commands like az iot central device list and others,
  now return list of items instead of a main dict with item ids as keys and items as values.

  Involved commands:

  • az iot central device list
  • az iot central device-template list
  • az iot central api-token list
  • az iot central user list

IoT Hub updates

• Fixed an issue in 0.10.16 causing IoT Hub command failure in Windows MSI environment.

Not Recommended for usage. Use 0.10.17+.

IoT Central updates

• Adds support for listing devices.
• Adds support for listing device templates.

IoT Hub updates

• Device simulation overhaul (az iot device simulate). Device simulation is experimental and subject to change.
  Please take a look at the --help docs for functionality and usage highlights.
• Device and module identity creation support usage of custom symmetric keys.

IoT Central updates

• Adds support for listing device groups
• Adds support for listing roles and get role by id

IoT Central updates

• Adds support to run root/interface level device commands.
• Adds support to get command history for root/interface level device commands.
• The --interface-id parameter for commands "device command run" , "device command history" changed to optional.

IoT Hub updates

• Decoding fix for az iot hub c2d-message receive - the command will use the "ContentEncoding" header value (which indicates the message body encoding) or fallback to utf-8 to decode the received message body.

• Addition for az iot hub generate-sas-token - the command will allow offline generation of SAS tokens using a connection string (via --connection-string).

• Changes to Edge validation for set-modules and edge deployment creation:

  By default only properties of system modules $edgeAgent and $edgeHub are validated against schemas installed with the IoT extension.
  This can be disabled by using the --no-validation switch.

Azure Digital Twins updates

• Addition of the following commands

  • az dt reset - Preview command which deletes all data entities from the target instance (models, twins, twin relationships).

General Update

• Min CLI core version raised to 2.17.1

IoT Central updates

• Public API GA update

  • Remove preview tag for api-token, device, device-template, user routes. Default routes use central GA API's.
  • Add support for preview and 1.0 routes.
  • Addition of the optional --av argument to specify the version of API for the requested operation.

IoT Hub updates

• Removed deprecated edge offline commands and artifacts.

• Removed deprecated device-identity | module-identity show-connection-string commands.

• Most commands against IoT Hub support Azure AD based access. The type of auth
  used to execute commands can be controlled with the --auth-type parameter
  which accepts the values key or login. The value of key is set by default.

  • When --auth-type has the value of key, like before the CLI will auto-discover
    a suitable policy when interacting with iothub.

  • When --auth-type has the value login, an access token from the Azure CLI logged in principal
    will be used for the operation.

  • The following commands currently remain with key based access only.

    • az iot hub monitor-events
    • az iot device c2d-message receive
    • az iot device c2d-message complete
    • az iot device c2d-message abandon
    • az iot device c2d-message reject
    • az iot device c2d-message purge
    • az iot device send-d2c-message
    • az iot device simulate

For more information about IoT Hub support for AAD visit: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-dev-guide-azure-ad-rbac

Azure Digital Twins updates

• Addition of the following commands

  • az dt model delete-all - Deletes all models associated with the Digital Twins instance.

IoT Hub updates

• Fixed an issue where an explicit json null could not be sent for the following commands:

  • az iot hub invoke-device-method
  • az iot hub invoke-module-method

• When using az iot hub connection-string show against all hubs in a group or subscription, the command will now
  show a warning instead of raising an error if a problem occurs obtaining a connection-string from a particular hub.

Azure Digital Twins updates

• Addition of the following commands

  • az dt twin delete-all - Deletes all digital twins within a Digital Twins instance.
  • az dt twin relationship delete-all - Deletes all digital twin relationships within a Digital Twins instance.

• Fixed an issue in the following update commands where malformed json patch content would not raise an error
  causing the process to call the respective service endpoint with a request payload containing an empty array. An error will now be raised.

  • az dt twin update
  • az dt twin relationship update
  • az dt twin component update

IoT Central updates

• Addition of the following commands

  • az iot central device manual-failover - Execute a manual failover of device across multiple IoT Hubs
  • az iot central device manual-failback - Reverts the previously executed failover command by moving the device back to it's original IoT Hub

For more information about device high availability visit https://github.com/iot-for-all/iot-central-high-availability-clients#readme

Azure Digital Twins updates

Addition of the optional --etag argument for the following commands:

• az dt twin [update | delete]
• az dt twin relationship [update | delete]

Addition of the optional --if-not-match switch for the following commands:

• az dt twin create
• az dt twin relationship create

Azure IoT Product Certification service updates

• Fix bug for az iot product test create sending malformed base64 string.

Azure Digital Twins updates

• Addition of Digital Twins Identity support focused around Managed Service Identity (MSI) and Identity based endpoint integration.
• Addition of Digital Twins networking functionality around private-links and private-endpoint connections. See az dt network.

IoT Hub updates

• Improve http debug logging.
• Fix bug related to issue #296. Adds a clause to device-identity update that allows user to update primary-key / secondary-key
  and primary-thumbprint / secondary-thumbprint values (respectively, per auth method) without needing to specify the auth_method in the update command.

IoT Central updates

• az iot central device, device-template, api-token and diagnostics command group help strings updated with improved language.
• Update of parsing template logic to support DTDL v2 models.
• Removal of deprecated commands 1) az iot central app device-twin 2) az iot central app monitor-events

IoT Hub updates

The following commands support an explicit etag parameter. If no etag arg is passed the value "*" is used.

• az iot hub device-identity update
• az iot hub device-identity delete
• az iot hub device-identity renew-key
• az iot hub device-twin update
• az iot hub device-twin delete
• az iot hub module-identity update
• az iot hub module-identity delete
• az iot hub module-twin update
• az iot hub module-twin delete
• az iot hub configuration update
• az iot hub configuration delete
• az iot edge deployment update
• az iot edge deployment delete

Re-introduce prior in-preview IoT Hub device digital twin/pnp runtime commands under the "az iot hub digital-twin" root command group.

• az iot hub digital-twin show
• az iot hub digital-twin update
• az iot hub digital-twin invoke-command

IoT Hub updates

Breaking change - command name altered from az iot hub device-identity regenerate-key to renew-key for better alignment with az cli verbs.