az iot adr
Note
This reference is part of the azure-iot extension for the Azure CLI (version 2.73.0 or higher). The extension will automatically install the first time you run an az iot adr command. Learn more about extensions.
Manage Azure Device Registry (ADR) resources.
Preview APIs support the Azure public cloud only. ADR management clients default to
https://management.azure.com. Set
AZURE_IOT_ADR_ARM_ENDPOINT=https://centraluseuap.management.azure.com to use canary ARM for ADR
namespaces, Update Instances, and link-target management requests.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az iot adr ns |
Manage Device Registry namespaces. |
Extension | Preview |
| az iot adr ns ca |
Manage certificate authorities for a Device Registry namespace. |
Extension | Preview |
| az iot adr ns ca activate |
Activate an externally issued intermediate certificate authority. |
Extension | Preview |
| az iot adr ns ca create |
Create a certificate authority for a Device Registry namespace. |
Extension | Preview |
| az iot adr ns ca delete |
Delete a certificate authority from a Device Registry namespace. |
Extension | Preview |
| az iot adr ns ca list |
List the certificate authorities for a Device Registry namespace. |
Extension | Preview |
| az iot adr ns ca policy |
Manage certificate policies for a certificate authority. |
Extension | Preview |
| az iot adr ns ca policy create |
Create a certificate policy for a certificate authority. |
Extension | Preview |
| az iot adr ns ca policy delete |
Delete a certificate policy from a certificate authority. |
Extension | Preview |
| az iot adr ns ca policy list |
List the certificate policies for a certificate authority. |
Extension | Preview |
| az iot adr ns ca policy show |
Show a certificate policy for a certificate authority. |
Extension | Preview |
| az iot adr ns ca policy update |
Update a certificate policy for a certificate authority. |
Extension | Preview |
| az iot adr ns ca policy wait |
Wait for a certificate policy to reach a desired state. |
Extension | Preview |
| az iot adr ns ca revoke |
Revoke and rotate an intermediate certificate authority issued by a Microsoft CA. |
Extension | Preview |
| az iot adr ns ca show |
Show a certificate authority for a Device Registry namespace. |
Extension | Preview |
| az iot adr ns ca update |
Update a certificate authority for a Device Registry namespace. |
Extension | Preview |
| az iot adr ns ca wait |
Wait for a certificate authority to reach a desired state. |
Extension | Preview |
| az iot adr ns create |
Create a Device Registry namespace. |
Extension | Preview |
| az iot adr ns delete |
Delete a Device Registry namespace. |
Extension | Preview |
| az iot adr ns device |
Manage Registry Devices in a Device Registry namespace. |
Extension | Preview |
| az iot adr ns device attribute |
Manage Registry Device attributes. |
Extension | Preview |
| az iot adr ns device attribute create |
Create or replace a User-reported attribute. |
Extension | Preview |
| az iot adr ns device attribute delete |
Delete an attribute by its literal resource name. |
Extension | Preview |
| az iot adr ns device attribute list |
List attributes, including service-reported metadata. |
Extension | Preview |
| az iot adr ns device attribute show |
Get an attribute. |
Extension | Preview |
| az iot adr ns device auth |
Inspect service-materialized authentication profiles. |
Extension | Preview |
| az iot adr ns device auth list |
List authentication profile metadata, not plaintext keys. |
Extension | Preview |
| az iot adr ns device auth revoke-certs |
Revoke certificates for a CA-signed X.509 profile. |
Extension | Preview |
| az iot adr ns device auth show |
Get authentication profile metadata. |
Extension | Preview |
| az iot adr ns device auth show-keys |
Retrieve plaintext keys for a SymmetricKey profile. |
Extension | Preview |
| az iot adr ns device auth wait |
Wait for authentication profile materialization or a specified condition. |
Extension | Preview |
| az iot adr ns device capability |
Inspect service-materialized Registry Device capabilities. |
Extension | Preview |
| az iot adr ns device capability list |
List Registry Device capabilities. |
Extension | Preview |
| az iot adr ns device capability show |
Get a discovered capability. |
Extension | Preview |
| az iot adr ns device create |
Create or replace a Registry Device. |
Extension | Preview |
| az iot adr ns device delete |
Delete a Registry Device. |
Extension | Preview |
| az iot adr ns device list |
List all Registry Devices in a namespace. |
Extension | Preview |
| az iot adr ns device show |
Get a Registry Device by name or external device ID. |
Extension | Preview |
| az iot adr ns device update |
Update writable Registry Device properties. |
Extension | Preview |
| az iot adr ns device wait |
Wait for Registry Device provisioning or a specified condition. |
Extension | Preview |
| az iot adr ns group |
Manage Device Registry namespace groups. |
Extension | Preview |
| az iot adr ns group count |
Show the current member count of a group. |
Extension | Preview |
| az iot adr ns group create |
Create a group in a Device Registry namespace. |
Extension | Preview |
| az iot adr ns group delete |
Delete a group from a Device Registry namespace. |
Extension | Preview |
| az iot adr ns group list |
List groups in a Device Registry namespace. |
Extension | Preview |
| az iot adr ns group list-members |
List the current members of a group. |
Extension | Preview |
| az iot adr ns group refresh |
Trigger an asynchronous refresh of a group's membership. |
Extension | Preview |
| az iot adr ns group show |
Show a group in a Device Registry namespace. |
Extension | Preview |
| az iot adr ns group update |
Update a group in a Device Registry namespace. |
Extension | Preview |
| az iot adr ns group wait |
Wait for a Device Registry group to reach a desired state. |
Extension | Preview |
| az iot adr ns identity |
Manage identities assigned to a Device Registry namespace. |
Extension | Preview |
| az iot adr ns identity assign |
Assign system- or user-assigned identities to a namespace. |
Extension | Preview |
| az iot adr ns identity remove |
Remove system- or user-assigned identities from a namespace. |
Extension | Preview |
| az iot adr ns identity show |
Show identities assigned to a namespace. |
Extension | Preview |
| az iot adr ns identity wait |
Wait for a namespace identity update to succeed. |
Extension | Preview |
| az iot adr ns job |
Manage Device Registry namespace jobs. |
Extension | Preview |
| az iot adr ns job create |
Create a job in a Device Registry namespace. |
Extension | Preview |
| az iot adr ns job delete |
Delete a job from a Device Registry namespace. |
Extension | Preview |
| az iot adr ns job list |
List jobs in a Device Registry namespace. |
Extension | Preview |
| az iot adr ns job run |
Manage runs of Device Registry namespace jobs. |
Extension | Preview |
| az iot adr ns job run cancel |
Cancel a Device Registry job run. |
Extension | Preview |
| az iot adr ns job run delete |
Delete a Device Registry job run. |
Extension | Preview |
| az iot adr ns job run list |
List job runs by parent job or across a namespace. |
Extension | Preview |
| az iot adr ns job run results |
Browse per-device results of a job run. |
Extension | Preview |
| az iot adr ns job run show |
Show a single run of a Device Registry job. |
Extension | Preview |
| az iot adr ns job run summary |
Show aggregate progress counts for a Device Registry job run. |
Extension | Preview |
| az iot adr ns job run wait |
Wait for a Device Registry job run to reach a desired state. |
Extension | Preview |
| az iot adr ns job schedule |
Schedule an execution of a Device Registry job. |
Extension | Preview |
| az iot adr ns job show |
Show a job in a Device Registry namespace. |
Extension | Preview |
| az iot adr ns job update |
Update tags on a job in a Device Registry namespace. |
Extension | Preview |
| az iot adr ns job wait |
Wait for a Device Registry job to reach a desired state. |
Extension | Preview |
| az iot adr ns link |
Manage links between a Device Registry namespace and downstream resources. |
Extension | Preview |
| az iot adr ns link add |
Link DPS first, then a Hub, to a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link dps |
Manage DPS links (provisioning endpoints) on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link dps add |
Link a Device Provisioning Service (DPS) to a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link dps list |
List DPS provisioning endpoints on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link dps remove |
Remove a DPS endpoint from a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link dps show |
Show a single DPS provisioning endpoint on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link dps update |
Update an existing DPS provisioning endpoint on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link dps wait |
Wait for a DPS endpoint to link successfully. |
Extension | Preview |
| az iot adr ns link hub |
Manage IoT Hub links (messaging endpoints) on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link hub add |
Link an IoT Hub to a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link hub list |
List IoT Hub messaging endpoints on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link hub remove |
Remove a IoT Hub endpoint from a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link hub show |
Show a single IoT Hub messaging endpoint on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link hub update |
Update an existing IoT Hub messaging endpoint on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link hub wait |
Wait for an IoT Hub endpoint to link successfully. |
Extension | Preview |
| az iot adr ns link su |
Manage Software Updates links (updating endpoints) on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link su add |
Link an Update Instance to a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link su list |
List Software Updates updating endpoints on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link su remove |
Remove a Software Updates instance endpoint from a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link su show |
Show a single Software Updates updating endpoint on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link su update |
Update an existing Software Updates updating endpoint on a Device Registry namespace. |
Extension | Preview |
| az iot adr ns link su wait |
Wait for a Software Updates endpoint to link successfully. |
Extension | Preview |
| az iot adr ns link wait |
Wait for selected or all namespace links to succeed. |
Extension | Preview |
| az iot adr ns list |
List Device Registry namespaces. |
Extension | Preview |
| az iot adr ns migrate |
Migrate legacy assets into a Device Registry namespace. |
Extension | Preview |
| az iot adr ns report |
Manage Device Registry update-compliance reports. |
Extension | Preview |
| az iot adr ns report generate |
Generate an update-compliance report. |
Extension | Preview |
| az iot adr ns report latest |
Show the latest update-compliance report. |
Extension | Preview |
| az iot adr ns show |
Show details of a Device Registry namespace. |
Extension | Preview |
| az iot adr ns su |
Manage Software Updates for Device Registry namespaces. |
Extension | Preview |
| az iot adr ns su device-class |
View and delete Software Updates device classes. |
Extension | Preview |
| az iot adr ns su device-class delete |
Delete a Software Updates device class. |
Extension | Preview |
| az iot adr ns su device-class list |
List device classes in a linked Software Updates instance. |
Extension | Preview |
| az iot adr ns su device-class show |
Show a Software Updates device class. |
Extension | Preview |
| az iot adr ns su instance |
Manage the Update Instance that powers Software Updates. |
Extension | Preview |
| az iot adr ns su instance check-name |
Check whether an Update Instance name is available. |
Extension | Preview |
| az iot adr ns su instance create |
Create an Update Instance. |
Extension | Preview |
| az iot adr ns su instance delete |
Delete an Update Instance. |
Extension | Preview |
| az iot adr ns su instance list |
List Update Instances. |
Extension | Preview |
| az iot adr ns su instance show |
Show an Update Instance. |
Extension | Preview |
| az iot adr ns su instance update |
Update an Update Instance's tags or managed identity. |
Extension | Preview |
| az iot adr ns su instance wait |
Wait for an Update Instance condition. |
Extension | Preview |
| az iot adr ns su software-update |
Import and manage Software Updates content. |
Extension | Preview |
| az iot adr ns su software-update calculate-hash |
Calculate update-file hashes locally. |
Extension | Preview |
| az iot adr ns su software-update catalog |
Discover Software Updates catalog identifiers. |
Extension | Preview |
| az iot adr ns su software-update catalog name |
Discover update names for a provider. |
Extension | Preview |
| az iot adr ns su software-update catalog name list |
List update names for a provider. |
Extension | Preview |
| az iot adr ns su software-update catalog provider |
Discover update providers. |
Extension | Preview |
| az iot adr ns su software-update catalog provider list |
List update providers in the catalog. |
Extension | Preview |
| az iot adr ns su software-update catalog version |
Discover update versions for a provider and name. |
Extension | Preview |
| az iot adr ns su software-update catalog version list |
List update versions for a provider and name. |
Extension | Preview |
| az iot adr ns su software-update delete |
Delete an imported update. |
Extension | Preview |
| az iot adr ns su software-update file |
Inspect files belonging to an imported update. |
Extension | Preview |
| az iot adr ns su software-update file list |
List file identifiers for an imported update. |
Extension | Preview |
| az iot adr ns su software-update file show |
Show an imported update file. |
Extension | Preview |
| az iot adr ns su software-update import |
Import an update into Software Updates. |
Extension | Preview |
| az iot adr ns su software-update init |
Create Software Updates import manifests locally. |
Extension | Preview |
| az iot adr ns su software-update init v5 |
Create a version 5 import manifest. |
Extension | Preview |
| az iot adr ns su software-update list |
List updates imported into Software Updates. |
Extension | Preview |
| az iot adr ns su software-update operation-status |
Inspect asynchronous Software Updates operations. |
Extension | Preview |
| az iot adr ns su software-update operation-status list |
List retained Software Updates operation statuses. |
Extension | Preview |
| az iot adr ns su software-update operation-status show |
Show a Software Updates operation status. |
Extension | Preview |
| az iot adr ns su software-update show |
Show an imported update. |
Extension | Preview |
| az iot adr ns su software-update stage |
Stage local update artifacts and optionally import them. |
Extension | Preview |
| az iot adr ns su software-update wait |
Wait for an imported Software Update condition. |
Extension | Preview |
| az iot adr ns update |
Update a Device Registry namespace. |
Extension | Preview |
| az iot adr ns wait |
Wait for a Device Registry namespace to reach a desired state. |
Extension | Preview |
