azure-iot-cli-extension

IoT Hub updates

• Fix az iot hub message-endpoint create to correctly pass the endpoint subscription when provided.

• Deprecate use of SHA1 hashes for certificate thumbprints. SHA256 hashes will be used for all certificate thumbprints.

• Addition of bulk key regeneration for az iot hub device-identity renew-key and az iot hub module-identity renew-key.

• Fix for az iot hub monitor-events when the IoT Hub has no partition Id's populated.

DPS updates

• Fix for az iot dps enrollement-group registration list to support paging.

General updates

• Updated the minimum core CLI version to 2.46.0

IoT Product updates

• [Breaking Change] Removed az iot product.

IoT Hub updates

• Fix for az iot hub state export to support storage account endpoints with system-assigned identity.

ADU updates

• Removed first-party handler validation check

IoT Hub updates

• Fix parsing issue for az iot hub certificate root-authority.

Digital Twins updates

• Updated Digital Twin dataplane API to use 2023-10-31. Affected commands:

  • az dt job deletion is now GA. Deletion jobs now have an option to add a timeout in minutes to cancel long-running jobs.
  • az dt job import, az dt model, and az dt twin now use the newer API but functionality remains the same.

IoT Hub updates

• Deprecation of az iot hub certificate root-authority. If your hub still uses a certificate on the Baltimore CyberTrust root,
  your hub will be migrated to the DigiCert Global G2 root in the next wave. For any issues, email [email protected].
  This command will be removed in a later release.

General updates

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

IoT Hub updates

• Fix for iot hub state commands failing on IoT Hubs missing certain ARM properties
• Minor updates to support GA of Cosmos DB container message endpoints

Digital Twins updates

• Addition of az dt job deletion to create deletion jobs. This job will delete all models, twins, and relationships, replacing az dt reset. The deletion jobs cannot be canceled or deleted. The added commands are:
  • az dt job deletion create
  • az dt job deletion list
  • az dt job deletion show
• The command az dt reset is deprecated and will be removed in a later update.

IoT Hub updates

• Add command group az iot hub message-endpoint update, which will allow you to update your message endpoint without deleting it.

• The IoT Hub name (--hub-name) can now be the IoT Hub name or hostname. This allows for RBAC authentication method (--auth-type login) to skip resource lookup if a hostname is provided. If properties beyond those that can be determined from the hostname are needed, resource lookup will still occur. Commands that do not support authentication methods will require the IoT Hub name.

IoT DPS updates

• The DPS name (--dps-name) can now be the DPS name or hostname. This allows for RBAC authentication method (--auth-type login) to skip resource lookup if a hostname is provided. If properties beyond those that can be determined from the hostname are needed, resource lookup will still occur.

Digital Twins updates

• Updated Digital Twin dataplane API to use 2023-06-30. Affected commands:
  • az dt job import is now GA.
  • az dt model and az dt twin now use the newer API but functionality remains the same.

IoT Hub updates

• Fixed issue where az iot hub monitor-events would hang when message payload cannot be decoded as unicode.
• az iot hub state migrate will now use the origin IoT Hub's resource group when the destination IoT Hub's resource group is not given.

IoT device updates

• az iot device send-d2c-message and az iot device c2d-message send now support providing message data from a file using the --data-file-path argument.
• az iot device c2d-message receive will now show a warning, along with other event properties, if the message payload cannot be decoded.

IoT Product

• Deprecation of az iot product. This command group will be removed in a future release.

IoT Hub updates

• Improved help for az iot edge deployment create to better describe layered deployments.
• The command az iot edge export-modules is now GA.

General updates

• The Azure IoT CLI extension min core CLI version incremented to 2.37.0.

Digital Twins updates

• Fix to ensure policy key retrieval during Digital Twin endpoint creation works. Affected command group: az dt endpoint create *.
• Addition of temporary experimental parameter --max-models-per-batch for az dt model create to let user adjust batch size when directory exceeds 250 models. Use to avoid DTDLParser errors.

IoT Hub updates

• Addition of the az iot hub state command group which introduces commands to save, upload, and copy states between IoT Hubs. This will
  allow for easier migration of IoT Hubs when changing location, IoT Hub SKU, number of Event Hub partitions and more.
  For more information, please read the trouble shooting guide here.

  The commands are as follows:

  • az iot hub state export to save the current state of an IoT Hub to a JSON file.
  • az iot hub state import to upload a state from a JSON file to an IoT Hub.
  • az iot hub state migrate to copy a state of an IoT Hub to another IoT Hub.

Digital Twins updates

• The Digital Twin controlplane commands will now use the newest API 2023-01-31. The following command groups are affected:

• az dt create, az dt delete, az dt list, az dt reset, az dt show, az dt wait
• az dt data-history
• az dt endpoint
• az dt identity
• az dt network
• az dt route

• Added new options for creating a data history connection and deleting one. The create command, az dt data-history connection create adx,
  now supports adding two separate tables for relationship lifecycle events and twin lifecycle events, recording property and item removals,
  and adding the new default for the generic table name (now known as property event table). The delete command,
  az dt data-history connection delete, now supports a clean parameter which will do a best-effort attempt to clean connection creation artifacts.

IoT Hub updates

• Addition of export modules command for edge devices:

  • az iot edge export-modules

Digital Twins updates

• Digital Twins dataplane commands now use the newer 2023-02-27-preview API. The following command groups are affected:

  • az dt model
  • az dt twin
  • az dt job

• az dt job import now supports newer job statuses, including "cancelling" and "cancelled". Now, to delete a running job, the job must be first cancelled with az dt job import cancel.

IoT Hub updates

• Addition of az iot hub message-endpoint and az iot hub message-route commands, which function similarly to
  existing az iot hub routing-endpoint and az iot hub route commands respectively. These new commands will
  use the newer IoT Hub Service API (2022-04-30-preview) if the Azure CLI supports it (min version 2.43.0). If the
  Azure CLI is not updated, the older API version will be used. A new endpoint type, Cosmos DB Containers is added
  with the newer API. Most of the command and parameter structure is the same, except for creation of endpoints,
  in which the type is specified in the command as so:

• az iot hub message-endpoint create cosmosdb-container
  • Hidden if the Azure CLI version does not support it.
• az iot hub message-endpoint create eventhub
• az iot hub message-endpoint create servicebus-queue
• az iot hub message-endpoint create servicebus-topic
• az iot hub message-endpoint create storage-container

Other notable changes which are not affected by API versions include:

• Addition of fallback route management through az iot hub message-route fallback set and
  az iot hub message-route fallback show

• Modification of how route testing works for testing all route sources. If az iot hub message-route test is called
  without specifying a route name or type, all types will be tested rather than only DeviceMessage routes.

• Addition of new parameters --custom-labels and --custom-metrics for az iot hub configuration create and
  az iot edge deployment create to let users input labels and metrics in key=value pair format.

Digital Twins updates

• Addition of User Assigned Identities for data history connections. The command az dt data-history connection create adx
  now can take an extra parameter --mi-user-assigned to use an associated User Assigned Identity for the connection
  creation rather than the system assigned identity for the Digital Twin.
• Some minor improvements to command documentation involving managed identities.

IoT Edge updates

• Introduces a new experimental command az iot edge devices create that enables advanced IoT Edge device creation and configuration.
  This command allows users to specify either multiple inline arguments (--device property=value) or a configuration file
  to create multiple edge devices (including nested device scenarios) and configure their deployments.

  If an output path is specified, this command will also create tar files containing each device's certificate bundle, an IoT Edge
  config.toml config file and an installation script to configure a target Edge device with these settings.

IoT DPS updates

• Removed file extension restriction for attached certificates in individual enrollments and enrollment groups creation/update commands,
  and added suggested certificate format in --help docs.

Device Update

• Refactored file hash operations for better performance and to overcome Windows 32-bit process memory constraints.
• Removed import manifest schema upper limit of file size in bytes.

IoT Hub updates

• The root-authority migration feature is now available. Since the Baltimore root will soon expire, IoT Hub will
  transition to the DigiCert Global G2 root starting February 15, 2023. You will need to update all device certificates
  to use the new G2 root.

  These commands are temporary and will be removed once all IoT Hubs have been transitioned:

  • az iot hub certificate root-authority show
  • az iot hub certificate root-authority set

  To learn more about this transition, visit http://aka.ms/iot-ca-updates/.

IoT Central updates

• Fixed an issue with enrollement group certificate encoding

Device Update

az iot du update init v5 improvements:

• Fixed an issue where duplicate files[] / relatedFiles[] entries were created via multiple usage of --file or
  --related-file against the same update file asset.
• If the inline step content handler requires handlerProperties.installedCriteria and a value was not provided,
  a default value will be automatically added with a warning.
• If the inline step content handler starts with 'microsoft' (case-insensitive), valid first-party handler values
  will be enforced.
• Inline json rules and examples provided for every shell.
• Improves error handling for free-form json properties.

Digital Twins

• New command group az dt identity to easily manage instance identities.
• az dt create supports adding user-managed identities on create.
• az dt endpoint create <type> commands support identity parameters - you are able to leverage managed identities
  to integrate with the target endpoint.
  • The eventgrid endpoint does not support managed identities.
• Resource group for endpoint resources are no longer required - if not present, the resource group of the
  digital twins instance is used.

Device Update

• Removed preview classification from the root Azure Device Update command group.
  Commands are GA with the exception of az iot du update stage and az iot du update init which are still preview.

IoT Hub updates

• [Breaking Change] The az iot hub device-identity export and az iot hub device-identity import commands have been migrated to use IoT Hub APIs instead of ARM.
• [Breaking Change] Device identity export/import commands now expect the parameter --auth-type to specify the IoT Hub API data access auth type (instead of storage access auth type).
• Updated the IoT Hub service SDK to now use the newer 2021-04-12 API version.
• Device identity export/import commands now support optional parameters for storage account and blob container names - users no longer need to supply input/output Blob container SAS URIs.
• Device identity export/import commands now automatically derive storage auth type - hence the parameter --storage-authentication-type has been deprecated.
• Adds az iot hub device-twin list as a highly recommended alternative to az iot hub device-identity list.
  Functionality remains the same as both return a list of device twins and az iot hub device-identity list may be altered or deprecated in the future.

Device Update

• The in-preview Azure Device Update CLI root namespace changed from az iot device-update to az iot du.
• The in-preview az iot device-update update init calculate-hash command moved to az iot du update calculate-hash.
• Introducing the preview az iot du update stage command. The update stage command is designed to automate
  the pre-requisite steps of importing an update. Read the command reference to learn more.

General updates

• The Azure IoT CLI extension min core CLI version incremented to 2.32.0.

Device Update

• Adds az iot device-update update init calculate-hash, a utility command used to calculate the base64 hash representation of one or more files.
• The update init v5 command will by default validate the generated import manifest using the official json schema definition. Client-side validation can be skipped by using --no-validation.
• The update init v5 command support level has changed from experimental to preview.

IoT Central updates

• --api-version parameter will be deprecated and ignored. The IoT Central API will alway call latest GA version or latest preview version (if any API only exists in preview).

• Add support for enrollment groups CRUD.

  • az iot central enrollment-group

    • az iot central enrollment-group list
    • az iot central enrollment-group show
    • az iot central enrollment-group create
    • az iot central enrollment-group delete
    • az iot central enrollment-group update
    • az iot central enrollment-group verify-certificate
    • az iot central enrollment-group generate-verification-code

• Add support for scheduled jobs CRUD.

  • az iot central scheduled-job

    • az iot central scheduled-job list
    • az iot central scheduled-job show
    • az iot central scheduled-job create
    • az iot central scheduled-job delete
    • az iot central scheduled-job update
    • az iot central scheduled-job list-runs

General Updates

• Fixes an issue where a global --subscription parameter was not being passed to some embedded CLI calls. Affected commands include:
  • az dt create
  • az dt job import
  • az iot device-update account create