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.
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
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 a SAS Token using a 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 updates
- 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.
- 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 a byte string instead of "regular" 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|diagnostic help strings updated with improved language.
- update parsing template logic to support DTDLV2 models.
- remove deprecated commands 1) iot central app device-twin 2) 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 update
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
- Change command name from az iot hub device-identity regenerate-key to renew-key to better align with az cli core verbs.
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.
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 more 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 changes
- Starting with v0.9.8 of the IoT extension, the minCliCoreVersion has been bumped to 2.3.1. This sets a comfortable minimum desired experience we want for our users.
Introducing preview commands for the Azure IoT Product Certification service
- A new 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 "... 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
Azure 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.
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
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
- 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"
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
- Device and module twin update operations provide explicit patch arguments (--desired, --tags).
- Adds command "az iot central app validate-messages"
- Remove Py 2.7 support and remnants from setup manifest.
- Remove Py 3.4 support and remnants from setup manifest.
- Adds edge configuration argument for creating or updating enrollment[groups]
- 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: (second attempt) Remove 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 enforced.
- SDK refresh. IoT Hub service calls (except for 'az iot dt' commands) point to api-version 2019-10-01.
- Extension package name has been changed to 'azure-iot'.
- 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.
- Adds Jobs v2 command set.
- Support IoT Edge layered deployments.
- Support ADM module twin definitions.
- Improved json schema validation error handling for edge deployments.
- Update top maximum for hub config/edge deployment list to 100.
- Breaking Change: Metric evaluation between hub configurations and edge deployments via show-metric work exactly the same.
- Breaking Change: New result format for az iot device c2d-message receive. The command now shows all properties.
- Updated IoT Central commands to allow the API for token collection to be overridden.
- az iot device c2d-message send supports sending all settable system properties per message.
- Updated uAMQP version range.
- Add user agent for MQTT & AMQP operations.
- Add QoS argument for send-d2c-message.
- For IoT Hub commands - improves json handling for arguments that require json.
- Edge deployments support metric definitions at creation time (like device configurations)
- Fixes issue with az iot hub invoke-device-method preventing primitive value payloads.
- The az iot device simulate command will send default values for content-type and content-encoding. These values can be overridden.
- Re-adds deprecated parameter --config-id to edge related commands. Note: --deployment-id/-d are the proper parameters to use in place of config-id when using edge deployment related commands.
- Device simulate now supports sending arbitrary message properties (like in send-d2c-message).
- The preview dt monitor events command has been simplified. It works the same as vanilla iot hub monitoring but filters dt events and allows filtering by interface.
- Help content improvements.
- Remove long since deprecated parameter --config-id from edge deployments.
- Removes long since deprecated command az iot hub apply-configuration.
- Resolve issue #100.
- Improve help content for az iot edge deployment update to explicitly show what can be updated.
- Fix message annotation used to filter Digital Twin events in az iot dt monitor-events.
- Resolve jsonschema dependency issue.
- PnP monitor events commands - Adds an option for filtering devices by twin query.
- PnP monitor events commands - Some existing mandatory parameters are now optional.
- Added support for iot central commands, monitor-events and device-twin show.
- Schema validation applies for creation of IoT Edge deployments or when setting modules per device.
- Added Azure IoT Plug & Play public preview functionality.
- Added support for distribution tracing commands.
- Minor fixes.
- Added support for deviceId wildcards and IoT Hub query language filtering to monitor-events.
- Added support for edge offline commands.
- Upgrade service Sdk to 2018-08-30-preview.
- Added --set-parent and --add-children to device-identity create to support edge offline feature.
- BREAKING CHANGES: The commands "az iot hub show-connection-string", "az iot hub device-identity show-connection-string" and "az iot hub module-identity show-connection-string" will no longer return the output with key "cs".
- Added --output support to monitor-events. Supports either json or yaml, i.e. az iot hub monitor-events --hub-name {} -d {} --output yaml
- Changed monitor-events to output JSON by default
- Added support to parse and display payload as JSON if system property Content-Type is provided and application/json (i.e. send-d2c-message ... --props $.ct=application/json from the CLI) or if monitor-events has a property --content-type/--ct of application/json (i.e. monitor-events --ct application/json).
- Upgrade DPS Sdk to V20180901 (#39)
- Add Reprovision and SymmetricKey attestation to the enrollment
- Support allocation-policy in enrollment
- Add new examples in help docs
- Replaced multi-character short options ('-props', for example) with long option prefixes '--' to satisfy Azure CLI CI linter requirements
- uAMQP out of band install will use range rule >=1.0.1,<1.1 instead of exact version
- Reworked monitor-events keyboardinterrupt handling
- Added initial scenario automation document with example script
- Significant reduction in extension install time
- Significant reduction in chance of deadlock on keyboard interrupt when using monitor-events (uamqp dependency incremented to v1.0.1)
- Monitor-events will throw a runtime exception upon errors.
- Catch empty sys.excepthook errors occasionally raised by underlying cancelled futures
- Test improvements + CLI testsdk path change to azure.cli.core.mock.DummyCli
- New command: iot hub monitor-feedback
- Event monitor now supports connection string based usage (via --login)
- Improvements to amqp functionality
- Increment extension target uamqp version to 0.1.1
- New complete command group: hub configuration (supports IoT device configuration)
- New command: edge set-modules (deprecates apply-configuration)
- New commands: <edge deployment or device configuration> show-metric
- Increment to service API version target
- Increment uAMQP to v0.1.0rc1. Dependency install will use exact version (vs compatible)
- Support Homebrew for out of band uAMQP install
- Help Text content++
- Misc tweaks and improvements
- Introduces C2D message send for Python 3.4+.
- Concurrently support 0.4.0 + 0.5.0 IoT mgmt SDK
- Improved top parameter for list ops
- Generalize uamqp dependency check (for operations that require it)
- First release of monitor-events command. Currently supports Python 3.5+, with increased support in future updates.
- Uses uamqp beta5 build as provider and therefore inherits its compatibility.
- Help text improvements.
- Generate sas token duration param will force int.
- Mode 2 login support for most IoT Hub commands. Provide an IoT Hub connection string via --login/-l for commands that support it.
- Added X509 root CA support for DPS enrollment groups
- Reworked device simulator
- Various fixes and tweaks.
- Device Provisioning Service Individual + Group enrollments support secondary cert for identity attestation.
- Encoding issue fixed for listing edge devices (with hub device-identity list -ee)
- IoT Edge workflow improved. Edge device modules will be immediately returned after applying a single device configuration.
- Major internal optimizations in package structure
- Travis CI integration
- Device Provisioning Service functionality added
- Updated command names/path
- First announced release
- Knack based Extension conversion
- Removed C IoT SDK dependencies (Python wrappers of)
- Added numerous IoT data-plane functionality
- Updated extension metadata
- Moved to internal SAS generate method
- Miscellaneous tweaks and improvements
- Build device connection string internally vs iot command module
- Clean-up
- Significant restructing of CLI, prioritizes pure Python solutions where possible
- Provides IoT Edge capabilities
- Adds following new commands:
- iot query
- iot device show
- iot device list
- iot device create
- iot device update
- iot device delete
- iot device twin show
- iot device twin update
- iot device module show
- iot device module list
- iot device module create
- iot device module update
- iot device module delete
- iot device module twin show
- iot device module twin update
- iot device module twin replace
- iot configuration apply
- iot configuration create
- iot configuration update
- iot configuration delete
- iot configuration show
- iot configuration list
- Bug fixes
- Updated extension metadata with tweaked Az CLI names.
- Device simulate supports receive count of infinity and message count of 0.
- Collection of new commands most of which use IoT SDK as the provider
- Show and update device twin
- Invoke device method
- Device simulation
- Hub message send (Cloud-to-device)
- New device message send (Device-to-cloud) supports http, amqp, mqtt
- Get SAS token