az iot adr ns report

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 report command. Learn more about extensions.

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

Manage Device Registry update-compliance reports.

Commands

Name	Description	Type	Status
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 report generate

Preview

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

Generate an update-compliance report.

Wait for generation to complete, then retrieve the latest report for the same type and group. With --no-wait, return the operation immediately without retrieving a report.

az iot adr ns report generate --namespace --ns
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]
                              [--gn --group-name]
                              [--no-wait]
                              [--report-type --type {GroupBestUpdatesComplianceReport, GroupInstallableUpdatesReport, NamespaceUpdateComplianceReport}]

Examples

Generate a namespace update-compliance report

az iot adr ns report generate --ns myNamespace -g myResourceGroup --report-type NamespaceUpdateComplianceReport

Generate a group best-updates report

az iot adr ns report generate --ns myNamespace -g myResourceGroup --report-type GroupBestUpdatesComplianceReport --group-name myGroup

Required Parameters

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--gn --group-name

Name of the device group. Required for group report types. The report identifies the group by its UUID (reportTarget).

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--report-type --type

Type of update compliance report.

Property	Value
Default value:	NamespaceUpdateComplianceReport
Accepted values:	GroupBestUpdatesComplianceReport, GroupInstallableUpdatesReport, NamespaceUpdateComplianceReport

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 report latest