az iot adr ns su software-update init

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 su software-update init command. Learn more about extensions.

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

Create Software Updates import manifests locally.

Commands

Name	Description	Type	Status
az iot adr ns su software-update init v5	Create a version 5 import manifest.	Extension	Preview

az iot adr ns su software-update init v5

Preview

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

Create a version 5 import manifest.

az iot adr ns su software-update init v5 --compat
                                         --step
                                         --un --update-name
                                         --up --update-provider
                                         --update-version --uv
                                         [--acquire-policy-token]
                                         [--change-reference]
                                         [--description]
                                         [--file]
                                         [--is-deployable {false, true}]
                                         [--no-validation {false, true}]
                                         [--related-file]

Examples

Create a simple manifest

az iot adr ns su software-update init v5 --update-provider Contoso \
  --update-name Thermostat --update-version 1.0 \
  --compat manufacturer=Contoso model=T1000 \
  --step handler=microsoft/script:1 --file path=./install.sh

Required Parameters

--compat

Compatible device properties as key=value pairs. --compat can be used more than once.

--step

Manifest step properties as key=value pairs. --step can be used more than once.

--un --update-name

Update name.

--up --update-provider

Update provider.

--update-version --uv

Update version.

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

--description

Description for the import manifest.

--file

Manifest file properties as key=value pairs. --file can be used more than once.

--is-deployable

Whether the update is independently deployable.

Property	Value
Accepted values:	false, true

--no-validation

Disable client-side import-manifest schema validation.

Property	Value
Accepted values:	false, true

--related-file

Related-file properties as key=value pairs. Each entry is associated with the nearest --file.

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