az iot adr ns device capability

  • Preview

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 ns device capability command. Learn more about extensions.

Command group 'iot adr ns device' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Inspect service-materialized Registry Device capabilities.

Capabilities are read-only. Provisioning services create them; the CLI does not synthesize them.

Commands

Name Description Type Status
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 capability list

Preview

Command group 'iot adr ns device capability' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Registry Device capabilities.

az iot adr ns device capability list --device-name --dn --rdn --registry-device-name
                                     --namespace --ns
                                     --resource-group

Examples

Discover capabilities.

az iot adr ns device capability list --rdn my-device --ns my-ns -g MyRG

Required Parameters

--device-name --dn --rdn --registry-device-name

Name of the parent Registry Device.

--namespace --ns

Name of the Device Registry namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az iot adr ns device capability show

Preview

Command group 'iot adr ns device capability' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a discovered capability.

az iot adr ns device capability show --capability-name --cn --name
                                     --device-name --dn --rdn --registry-device-name
                                     --namespace --ns
                                     --resource-group

Examples

Inspect an IoT Hub capability whose name is the namespace messaging endpoint.

az iot adr ns device capability show -n my-hub-endpoint --rdn my-device --ns my-ns -g MyRG

Required Parameters

--capability-name --cn --name -n

Name of the Registry Device capability.

--device-name --dn --rdn --registry-device-name

Name of the parent Registry Device.

--namespace --ns

Name of the Device Registry namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False