az iot adr ns job run

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

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

Manage runs of Device Registry namespace jobs.

A job describes what to deploy and where; a run is one execution of it. Schedule a run with 'az iot adr ns job schedule'.

Commands

Name	Description	Type	Status
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 run cancel

Preview

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

Cancel a Device Registry job run.

az iot adr ns job run cancel --jn --job-name
                             --name --rn --run-name
                             --namespace --ns
                             --resource-group
                             [--acquire-policy-token]
                             [--change-reference]
                             [--no-wait]
                             [--yes {false, true}]

Examples

Cancel a run

az iot adr ns job run cancel -n myRun --job-name myJob --ns myNamespace -g myResourceGroup

Required Parameters

--jn --job-name

Name of the parent job that owns this run.

--name --rn --run-name -n

Name of the job run.

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

--no-wait

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

Property	Value
Default value:	False

--yes -y

Skip user prompts. Indicates acceptance of action. Used primarily for automation scenarios. Default: false.

Property	Value
Accepted values:	false, true

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 job run delete

Preview

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

Delete a Device Registry job run.

Deletes the run record. Cancel an in-flight run with 'az iot adr ns job run cancel' before deleting it.

az iot adr ns job run delete --jn --job-name
                             --name --rn --run-name
                             --namespace --ns
                             --resource-group
                             [--acquire-policy-token]
                             [--change-reference]
                             [--no-wait]
                             [--yes {false, true}]

Examples

Delete a job run

az iot adr ns job run delete -n myRun --job-name myJob --ns myNamespace -g myResourceGroup

Required Parameters

--jn --job-name

Name of the parent job that owns this run.

--name --rn --run-name -n

Name of the job run.

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

--no-wait

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

Property	Value
Default value:	False

--yes -y

Skip user prompts. Indicates acceptance of action. Used primarily for automation scenarios. Default: false.

Property	Value
Accepted values:	false, true

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 job run list

Preview

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

List job runs by parent job or across a namespace.

az iot adr ns job run list --namespace --ns
                           --resource-group
                           [--filter]
                           [--jn --job-name --name]
                           [--ob --order-by]

Examples

List all runs for a job

az iot adr ns job run list --job-name myJob --ns myNamespace -g myResourceGroup

List active runs across the namespace

az iot adr ns job run list --ns myNamespace -g myResourceGroup --filter "status eq 'Active'"

List active or scheduled runs

az iot adr ns job run list --ns myNamespace -g myResourceGroup --filter "status in ('Active', 'Scheduled')"

List runs ordered by status

az iot adr ns job run list --ns myNamespace -g myResourceGroup --order-by "status asc"

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.

--filter

Status filter using 'eq' or 'in', for example: status in ('Active', 'Scheduled').

--jn --job-name --name -n

Optional parent job name. Omit to list runs across the namespace.

--ob --order-by

Sort expression for job runs, for example: "status asc" or "status desc".

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 job run results

Preview

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

Browse per-device results of a job run.

Returns a flat list of per-device results aggregated across all pages of the service-side POST .../listResults response. Use --filter for server-side status filtering.

az iot adr ns job run results --jn --job-name
                              --name --rn --run-name
                              --namespace --ns
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]
                              [--filter]
                              [--ob --order-by]

Examples

List every per-device result for a run

az iot adr ns job run results -n myRun --job-name myJob --ns myNamespace -g myResourceGroup

Show only the failed devices in a run

az iot adr ns job run results -n myRun --job-name myJob --ns myNamespace -g myResourceGroup \
  --filter "status eq 'Failed'"

Order device results by status

az iot adr ns job run results -n myRun --job-name myJob --ns myNamespace -g myResourceGroup \
  --order-by "status asc"

Required Parameters

--jn --job-name

Name of the parent job that owns this run.

--name --rn --run-name -n

Name of the job run.

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

--filter

One result status equality clause, for example: status eq 'Failed'.

--ob --order-by

Sort results by status: "status", "status asc", or "status desc".

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 job run show

Preview

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

Show a single run of a Device Registry job.

az iot adr ns job run show --jn --job-name
                           --name --rn --run-name
                           --namespace --ns
                           --resource-group

Examples

Show a job run

az iot adr ns job run show -n myRun --job-name myJob --ns myNamespace -g myResourceGroup

Required Parameters

--jn --job-name

Name of the parent job that owns this run.

--name --rn --run-name -n

Name of the job run.

--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 job run summary

Preview

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

Show aggregate progress counts for a Device Registry job run.

Returns the target counts for the run: total, succeeded, failed, inProgress, pending, canceled and notApplied. Use 'az iot adr ns job run results' to see the individual devices behind these counts.

az iot adr ns job run summary --jn --job-name
                              --name --rn --run-name
                              --namespace --ns
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]

Examples

Show the progress summary for a run

az iot adr ns job run summary -n myRun --job-name myJob --ns myNamespace -g myResourceGroup

Required Parameters

--jn --job-name

Name of the parent job that owns this run.

--name --rn --run-name -n

Name of the job run.

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

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 job run wait

Preview

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

Wait for a Device Registry job run to reach a desired state.

Without an explicit wait predicate, waits for status Succeeded. Failed, Canceled, and TimedOut are surfaced immediately as unsuccessful terminal states.

az iot adr ns job run wait --jn --job-name
                           --name --rn --run-name
                           --namespace --ns
                           --resource-group
                           [--acquire-policy-token]
                           [--change-reference]
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--interval]
                           [--timeout]
                           [--updated]

Examples

Wait until a job run succeeds

az iot adr ns job run wait -n myRun --job-name myJob --ns myNamespace -g myResourceGroup

Explicitly wait for cancellation

az iot adr ns job run wait -n myRun --job-name myJob --ns myNamespace -g myResourceGroup --custom "properties.status=='Canceled'"

Required Parameters

--jn --job-name

Name of the parent job that owns this run.

--name --rn --run-name -n

Name of the job run.

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

--created

Wait until provisioningState is Succeeded.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until a custom JMESPath expression evaluates to true.

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until the resource is deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--timeout

Polling budget in seconds, including GET time. An in-flight GET is bounded by transport timeouts and cannot be interrupted by this polling deadline.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until provisioningState is Succeeded.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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