azure-iot-cli-extension

The following features depend on service capabilities that will be released soon.

• Support IoT Edge layered deployments.
• Support ADM module twin definitions.

The remaining features are generally available.

• 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.

• 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.
• Metric evaluation for hub configuration and edge deployment via show-metric work exactly the same.

• For IoTHub commands - improves json handling for arguments that require json.
  • For overloaded arguments which can be a file path or raw json, if an input file path does not exist but looks like a file (ends in a common file prefix) then the CLI will provide a warning indicating so.
  • Clearer error messages if json parsing fails. The error describes the failed argument and the file (if applicable).
• Edge deployments support metric definitions at creation time via --metrics argument (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 (resolves issue #113 )
  • 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) (issue #103)
• 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
• Removed long since deprecated parameter --config-id from edge related commands

• 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 in an existing edge deployment.
• Fix message annotation used to filter Digital Twin events in az iot dt monitor-events

• Resolve jsonschema load 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.

• Introduces Azure IoT Plug & Play public preview functionality

Compatible with Azure CLI core 2.0.70 and up.

Changes in this release:

• Updated description for generate-sas-token command
• Added E2E Support (distributed tracing)
• Removed min_profile attribute for compatibility with Core CLI
• Minor fixes to integration and unit tests

Breaking Changes:

• The az iot hub show-connection-string command has been removed from the extension in favor of the CLI core implementation.
  Therefore with this release, the hub name parameter has changed from --hub-name to --name.
  We will be working to update the CLI core to provide a consistent usage experience in the near future.

• The following connection string commands will no longer return output with a key of cs, this key is now connectionString, which is consistent with the core CLI:

  az iot hub show-connection-string
az iot hub device-identity show-connection-string
az iot hub module-identity show-connection-string

New Features:

• Added support for deviceId wildcards and IoT Hub query language filtering to monitor-events.
• Added support for edge offline commands.
• Added --set-parent and --add-children to device-identity create to support edge offline feature.

Other changes:

• Upgrade service Sdk to 2018-08-30-preview.

Compatible with Azure CLI core 2.0.24 and up.

• 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).

Compatible with Azure CLI core 2.0.24 and up.

• DPS functionality using '2018-09-01-preview' SDK version
• Add Reprovision and SymmetricKey attestation to the enrollment
• Support for Allocation-Policy in Enrollment
• Add symmetric key in enrollment-group
• Add new DPS examples in help docs

Compatible with Azure CLI core 2.0.24 and up.

• (Breaking change) Replaced multi-character short options with long option prefixes
• Version update and breaking changes announcement
• Updated 'iot hub configuration' commands in help
• Updated minimum uamqp version to 1.0.3

Compatible with Azure CLI core 2.0.24 and up.

• 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

Compatible with Azure CLI core 2.0.24 and up.

• 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
• Added basic issue template.

Compatible with Azure CLI core 2.0.24 and up.

• New command: iot hub monitor-feedback
• Event monitor now supports connection string based usage (via --login)
• You can now wait for device ack feedback after sending a C2D message
• Improvements to amqp functionality
• Increment extension target uamqp version to 0.1.1

Compatible with Azure CLI core 2.0.24 and up.

• 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

Compatible with Azure CLI core 2.0.24 and up.

• 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)

Compatible with Azure CLI core 2.0.24 and up.

• 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.

Compatible with Azure CLI core 2.0.24 and up.