azure-iot-cli-extension

Azure IoT Product Certification service

• Fix bug for az iot product test create not specifying query parameter "GenerateProvisioningConfiguration" appropriately.

IoT Hub updates

• SDK refresh. IoT Hub service calls point to api-version 2020-09-30.

• Fixes a bug where device scopes would be reset when executing az iot device-identity update.

• Updated nested edge (edge offline) commands to support parentScopes.

  Set of changes

  • az iot hub device-identity get-parent is deprecated use az iot hub device-identity parent show instead. Deprecated command group is planned to be removed by December 2021
  • az iot hub device-identity set-parent is deprecated use az iot hub device-identity parent set instead. Deprecated command is planned to be removed by December 2021
  • az iot hub device-identity add-children is deprecated use az iot hub device-identity children add instead. Deprecated command group is planned to be removed by December 2021
  • az iot hub device-identity remove-children is deprecated use az iot hub device-identity children remove instead. Deprecated command is planned to be removed by December 2021
  • az iot hub device-identity list-children is deprecated use az iot hub device-identity children list instead. Deprecated command group is planned to be removed by December 2021

Azure Digital Twins updates

• Breaking change on the --tags parameter for az dt create. The prior input format of --tags "a=b;c=d" has been changed to --tags a=b c=d to be consistent with other Az CLI tag formats.

General updates

• IoT extension installation constrained to Python 3.6 or greater.

Azure Digital Twins updates

• ADT GA updates and release.

IoT Edge

• Validation schema updated with $edgeHub 1.1 route option.
• Introduces --no-validation to skip client side schema based validation for edge deployment creation.

General updates

• Python 3.5 support will soon be dropped corresponding with the official end of life date.
• Formal python requires constraint added to constrain installs to Py 3.5+.

IoT Plug-and-Play updates

• The in preview az iot pnp command group has been removed. PnP CLI functionality will be re-imagined at a future point in time.

IoT Hub updates

• Adds az iot hub device-identity regenerate-key.

IoT Plug-and-Play updates

• Regenerated PnP runtime SDK to API version 2020-09-30
• All az iot pnp commands still remain under preview and are subject to change or deletion.

IoT Hub updates

• All configuration/edge deployment list operations no longer have a default top. By default all configuration entities will be returned.
  Existing --top input should not be affected.

IoT Hub updates

• Add convenience arguments for device update.

IoT DPS updates

• Added --show-keys argument to dps enrollment show and dps enrollment-group show to include full attestation information for symmetric key enrollments and enrollment groups
• Regenerated 2019-03-31 DPS Service SDK

Breaking Changes

• az iot dps enrollment show and az iot dps enrollment-group show now return raw service results instead of deserialized models.
  This means that some properties that were previously returned as null for these commands will no longer be returned, possibly causing a breaking change.

IoT DPS updates

• Introduces 'az iot dps compute-device-key' preview command to generate derived device SAS key

IoT Central updates

• Introduces 'az iot central diagnostics' preview command group to perform application and device level diagnostics

• Introduces 'az iot central device compute-device-key' preview command to generate derived device SAS key

• This release involves a re-grouping of IoT Central commands.

  Set of changes for GA commands

  • 'az iot central app device-twin' is deprecated use 'az iot central device twin' instead. Deprecated command group is planned to be removed by December 2020
  • 'az iot central app monitor-events' is deprecated use 'az iot central diagnostics monitor-events' instead. Deprecated command is planned to be removed by December 2020

  Set of changes for preview commands

  • 'az iot central app device registration-summary' moved to 'az iot central diagnostics registration-summary'
  • 'az iot central app monitor-properties' moved to 'az iot central diagnostics monitor-properties'
  • 'az iot central app validate-messages' moved to 'az iot central diagnostics validate-messages'
  • 'az iot central app validate-properties' moved to 'az iot central diagnostics validate-properties'
  • 'az iot central diagnostics monitor-events' added to support deprecation of 'az iot central app monitor-events'
  • 'az iot central app device run-command' moved to 'az iot central device command run'
  • 'az iot central app device show-command-history' moved to 'az iot central device command history'
  • 'az iot central device twin' added to support deprecation of 'az iot central app device-twin' command group

IoT Hub updates

Cloud-to-Device message enhancements

• Introduced new az iot device c2d-message purge command to purge the message queue for a device.

• Added message ack arguments to az iot c2d-message receive to ack the message after it is received:

  • Options are --complete, --abandon, and --reject, and only one can be used per command.
  • az iot device c2d-message receive with no ack arguments remains unchanged and will not ack the message.

Edge device creation enhancements

• Enabled x509 certificate authentication types (x509_thumbprint and x509_ca) for edge device creation with az iot hub device-identity create --ee

Bug fixes

• Fixes issue #243 where providing a connection string via --login still required "az login".

Digital Twins updates

The following command groups support passing in a DT instance hostname directly.

az dt route
az dt model
az dt twin

• Like before, if an instance name is provided, the user subscription is first queried for the target instance to retrieve the hostname.
• If a hostname is provided, the subscription query is skipped and the provided value is used for subsequent interaction.

General change

• With v0.9.8 of the IoT extension, the minimum Azure CLI version has been bumped to 2.3.1. This reflects a minimum desired experience we want for our users.
• If you cannot support at least Azure CLI v 2.3.1, then prior versions of the extension can be installed.

Introducing commands for the Azure IoT Product Certification service

• A new preview IoT root command group az iot product has been added
  • Use az iot product requirement to manage product certification requirements
  • Use az iot product test to manage device tests for certification
    • The product test command group encompasses test cases, runs and tasks

IoT Central updates

• Introduces the az iot central app user preview command group for managing application users and service principals
• Introduces the az iot central app api-token preview command group for managing application api tokens
• Removal of deprecated command groups and commands

IoT Hub updates

• All prior existing ... show-connection-string based commands are deprecated in favor of ... connection-string show canonical Az CLI style.
  • The show connection string command for a target IoT Hub has moved to the IoT extension.
  • az iot hub connection-string show supports a --default-eventhub flag which indicates the operation will construct a connection string for the default eventhub endpoint of the target IoT Hub.
• Export/Import device identity commands support reading blob container SAS URI's via file

Digital Twins updates

• The 'location' argument for az dt create is now optional. If no location is provided, the location of the target resource group is used.

• The "azure-cli-iot-ext" CLI extension has been deprecated since early 2020. This release merely increases the visibility of deprecation by updating the package description, command group descriptions and showing warnings when commands are run.
• The "azure-iot" extension replaces the legacy extension. You should never have both installed at the same time.
• The legacy extension is scheduled for removal from the extension index after 09/15/2020.
• For more information, see https://github.com/Azure/azure-iot-cli-extension#news

Refreshes commands for the Azure IoT Plug & Play summer refresh

• The existing Plug & Play preview commands across Azure CLI and the IoT extension have been removed and replaced with a completely new commands. If you still need the legacy preview experience, then you can leverage older versions of the CLI and extension.
• The new commands exist entirely in the extension with the following command groups:
  • az iot pnp repo ## For tenant repository configuration
  • az iot pnp model ## For managing repository models and related content
  • az iot pnp role-assignment ## For managing role assignments for model repo assets
  • az iot pnp twin ## For interacting with the digital twin of a Plug & Play device

Introduces new preview Azure IoT Central commands

• az iot central app monitor-properties
• az iot central app validate-properties
• az iot central app device run-command
• az iot central app device show-command-history
• az iot central app device show-credentials

Device Provisioning Service update

• DPS enrollments now support the custom allocation policy resolving issue #200

• Fixes event monitor initialization issue.

• IoT Hub commands now support dynamic privileged policy discovery. iothubhowner is no longer relied on. Instead any policy that has RegistryWrite, ServiceConnect and DeviceConnect permissions will be used.
• Monitoring commands (such as for central or hub) support module Id filter. Also it is more clear that an event comes from a module.
• Improved validation of central telemetry.
• Digital Twin endpoint create commands now support custom subscription options.

Azure Digital Twins Public Preview - CLI release.

The public preview service will be available soon.

Introducing 35 new commands in the following command groups:

• az dt
• az dt endpoint
• az dt model
• az dt role-assignment
• az dt route
• az dt twin
• az dt twin relationship
• az dt twin telemety

Content

• IoT Hub device identity import/export commands support usage via managed service identity using the --auth-type argument.
• Adds preview command group az iot central app device
  • Adds preview command az iot central app device create
  • Adds preview command az iot central app device show
  • Adds preview command az iot central app device list
  • Adds preview command az iot central app device delete
  • Adds preview command az iot central app device registration-info
  • Adds preview command az iot central app device registration-summary
• Adds preview command group az iot central app device-template
  • Adds preview command az iot central app device-template create
  • Adds preview command az iot central app device-template show
  • Adds preview command az iot central app device-template list
  • Adds preview command az iot central app device-template delete
  • Adds preview command az iot central app device-template map
• Changed how results are displayed in az iot central app validate-messages

Examples:

Get device registration information.

• az iot central app device registration-info --app-id AppId -d DeviceId

Get registration summary of all devices.

• az iot central app device registration-summary --app-id AppId

Validate message payload sent by the device to IoT Central.

• az iot central app validate-messages --app-id AppId -d DeviceId

Get a mapping of device template name to device template id.

• az iot central app device-template map --app-id AppId

Known issues:

• The following preview commands will retrieve at most 25 results
  • az iot central app device list
  • az iot central app device-template list
  • az iot central app device-template map

• Resolves issue #156. Device and module twin update operations provide explicit patch arguments (--desired, --tags). Usage of the generic update arguments (i.e. --set) are deprecated.
• Adds preview command az iot central app validate-messages
• Remove Py 2.7 remnants from setup manifest.

Device Provisioning Service update

• Adds edge configuration argument for creating or updating enrollment[groups]
  • Use --edge-enabled

For example

• Create an enrollment group with edge enabled
  • az iot dps enrollment-group create --dps-name MyDPS --enrollment-id MyEnrollmentGroup -g MyRG --edge-enabled
• Update to turn on edge configuration
  • az iot dps enrollment update --dps-name MyDPS --enrollment-id MyEnrollmentGroup -g MyRG --edge-enabled
• Update to turn off edge configuration
  • az iot dps enrollment update --dps-name MyDPS --enrollment-id MyEnrollmentGroup -g MyRG --edge-enabled False

• Extension package has been renamed to azure-iot.
• IoT Hub SDK refresh. Service calls (except for az iot dt commands) point to api-version 2019-10-01.
• Breaking change: Evaluating an edge deployment/hub configuration SYSTEM metric (via show-metric) will return non-manipulated query output.
  • This means the result is always a collection of objects.
• Breaking change: Removed long since deprecated parameter --config-id from edge deployments.
  • Use --deployment-id or -d instead.
• When creating ADM module configurations, the target condition starting with 'from devices.modules where' is required and enforced.
• Help text for ADM module configurations has been updated with proper target condition syntax for module criteria.

• Updated uamqp version to ~1.2.
• Simplified out-of-band dependency installation message.
• If uamqp installation fails the error is raised on stderr rather than having to use --debug.
• amqp frame traces are not shown when --debug is passed in to event monitoring.
• Fixed monitor-events not raising an exception if receiver client runs into an error.

• Introducing the addition of the job command set az iot hub job
  • Supersedes the vanilla Azure CLI IoT job commands. The vanilla commands are deprecated and scheduled for removal.
  • Allows the creating and scheduling of v2 Jobs for at scale device manipulation. This includes scheduleUpdateTwin and scheduleDeviceMethod.
    • Throttling limits apply
  • Show/List/Cancel command operations work against both v1 and v2 jobs providing a 'single pane' experience.