az iot product test task

  • Deprecated
  • Reference

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.37.0 or higher). The extension will automatically install the first time you run an az iot product test task command. Learn more about extensions.

This command group is implicitly deprecated because command group 'iot product' is deprecated and will be removed in a future release.

Manage product testing certification tasks.

Commands

Name Description Type Status
az iot product test task create

Queue a new testing task. Only one testing task can be running at a time.

 Extension Deprecated
az iot product test task delete

Cancel a running task matching the specified --task-id.

 Extension Deprecated
az iot product test task show

Show the status of a testing task. Use --running for current running task or --task-id.

 Extension Deprecated

az iot product test task create

Deprecated

This command is implicitly deprecated because command group 'iot product' is deprecated and will be removed in a future release.

Queue a new testing task. Only one testing task can be running at a time.

az iot product test task create --test-id
                                [--base-url]
                                [--interval]
                                [--type {GenerateTestCases, QueueTestRun}]
                                [--wait {false, true}]

Examples

Basic usage

az iot product test task create --test-id {test_id}

Wait for completion and return test case

az iot product test task create --test-id {test_id} --wait

Wait for completion with custom polling interval to completion and return test case

az iot product test task create --test-id {test_id} --wait --poll-interval 5

Required Parameters

--test-id -t

The generated Id for the device certification test.

Optional Parameters

--base-url

Override certification service URL to allow testing in non-production environements.

--interval --poll-interval

Used in conjunction with --wait. Sepcifies how frequently (in seconds) polling occurs.

default value: 3
--type

The type of task for the device test.

accepted values: GenerateTestCases, QueueTestRun
default value: QueueTestRun
--wait -w

Wait for task completion and return test case data when available.

accepted values: false, true
default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az iot product test task delete

Deprecated

This command is implicitly deprecated because command group 'iot product' is deprecated and will be removed in a future release.

Cancel a running task matching the specified --task-id.

az iot product test task delete --task-id
                                --test-id
                                [--base-url]

Examples

Basic usage

az iot product test task delete --test-id {test_id} --task-id {task_id}

Required Parameters

--task-id

The generated Id of the testing task.

--test-id -t

The generated Id for the device certification test.

Optional Parameters

--base-url

Override certification service URL to allow testing in non-production environements.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az iot product test task show

Deprecated

This command is implicitly deprecated because command group 'iot product' is deprecated and will be removed in a future release.

Show the status of a testing task. Use --running for current running task or --task-id.

az iot product test task show --test-id
                              [--base-url]
                              [--running {false, true}]
                              [--task-id]

Examples

Task status by --task-id

az iot product test task show --test-id {test_id} --task-id {task_id}

Currently running task of product test

az iot product test task show --test-id {test_id} --running

Required Parameters

--test-id -t

The generated Id for the device certification test.

Optional Parameters

--base-url

Override certification service URL to allow testing in non-production environements.

--running

Get the running tasks of a device test.

accepted values: false, true
default value: False
--task-id

The generated Id of the testing task.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.