Releases: Azure/azure-iot-cli-extension
azure-iot 0.17.1
Device Update
- The Device Update control plane (or infrastructure related) command groups
az iot device-update account
and
az iot device-update instance
now use the GA API version of2022-10-01
. - The Device Update data plane command groups
az iot device-update device
and
az iot device-update update
now use the GA API version of2022-10-01
. - The command
az iot device-update device class list
adds support for--filter
when no--group-id
is provided. - The parameters
--account
,--instance
, and--resource-group
support setting default overridable values via config.- Use
az config set
i.e.az config set defaults.adu_account=<name>
oraz configure
i.e.az configure --defaults adu_account=<name>
.
- Use
- Introducing the experimental command
az iot device-update update init v5
for initializing (or generating) an import manifest
with the desired state. - Improved built-in documentation.
- The
az iot device-update
command group remains under preview.
azure-iot 0.17.0
Device Update
- The Device Update command group supports all data plane functionality via in-preview
update
anddevice
sub-command groups. The data plane API version used is 2022-07-01-preview.
IoT Hub updates
- Updated the
az iot hub monitor-events
command to support an optional--message-count
argument.
The message-count defines the maximum number of messages received from the hub before the monitor automatically stops.
If not provided the monitor keeps running until the user force-kills the monitor.
azure-iot 0.16.1
General updates
- Fixes issue preventing reference docgen.
azure-iot 0.16.0
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
andinstance
related functionality against
control plane API version 2022-04-01-preview.
- The Device Update command group supports all
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
- az iot central device-group
-
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
- az iot central device attestation
-
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
andaz 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.
azure-iot 0.15.0
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
andinstance
related functionality.
- This command group is behind a feature flag environment variable. Set
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 otheraz 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.
azure-iot 0.14.1
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.
azure-iot 0.14.0
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 toaz 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 useaz iot dps enrollment-group compute-device-key
instead.az iot dps registration
is deprecated useaz iot dps enrollment-group registration
instead.az iot dps registration delete
is deprecated useaz iot dps enrollment-group registration delete
instead.az iot dps registration list
is deprecated useaz iot dps enrollment-group registration list
instead.az iot dps registration show
is deprecated useaz iot dps enrollment-group registration show
instead.
azure-iot 0.13.0
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
andaz iot dps enrollment update
support
optional device information via--device-info
azure-iot 0.12.1
IoT DPS updates
- Resolves issue where usage of
--login
with connection string still requiredaz login
.
azure-iot 0.12.0
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
)
- Query (
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 foraz 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.