az iot product test

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 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 device tests for product certification.

Commands

Name	Description	Type	Status
az iot product test case	Manage product testing certification test cases.	Extension	Deprecated
az iot product test case list	List the test cases of a product certification test.	Extension	Deprecated
az iot product test case update	Update the product certification test case data.	Extension	Deprecated
az iot product test create	Create a new product test for product certification.	Extension	Deprecated
az iot product test run	Manage product testing certification test runs.	Extension	Deprecated
az iot product test run show	Show the status of a testing run.	Extension	Deprecated
az iot product test run submit	Submit a completed test run to the partner/product service.	Extension	Deprecated
az iot product test search	Search product repository for testing data.	Extension	Deprecated
az iot product test show	View product test data.	Extension	Deprecated
az iot product test task	Manage product testing certification tasks.	Extension	Deprecated
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 update	Update the product certification test data.	Extension	Deprecated

az iot product test create

Deprecated

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

Create a new product test for product certification.

az iot product test create [--at {ConnectionString, SymmetricKey, TPM, X509}]
                           [--badge-type {IotDevice, IotEdgeCompatible, Pnp}]
                           [--base-url]
                           [--certificate-path]
                           [--cf]
                           [--connection-string]
                           [--device-type {DevKit, FinishedProduct}]
                           [--ek]
                           [--models]
                           [--product-id]
                           [--skip-provisioning]
                           [--validation-type {Certification, Test}]

Examples

Basic usage

az iot product test create --configuration-file {configuration_file}

Do not have service create provisioning configuration

az iot product test create --configuration-file {configuration_file} --skip-provisioning

Creating test with symmetric key attestation

az iot product test create --attestation-type SymmetricKey --device-type {device_type}

Creating test with TPM attestation

az iot product test create --attestation-type TPM --device-type {device_type} --endorsement-key {endorsement_key}

Creating test with x509 attestation

az iot product test create --attestation-type x509 --device-type {device_type} --certificate-path {certificate_path}

Creating test for Edge module

az iot product test create --attestation-type ConnectionString --device-type {device_type} --badge-type IotEdgeCompatible --connection-string {connection_string}

Creating test with symmetric key attestation and specified validation type

az iot product test create --attestation-type SymmetricKey --device-type {device_type} --validation-type Certification --product-id {product_id}

Optional Parameters

--at --attestation-type

How the device will authenticate to testing service Device Provisioning Service.

accepted values: ConnectionString, SymmetricKey, TPM, X509

--badge-type --bt

The type of certification badge.

accepted values: IotDevice, IotEdgeCompatible, Pnp

default value: IotDevice

--base-url

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

--certificate-path --cp

The path to the file containing the primary certificate. When choosing x509 as attestation type, one of the certificate path is required.

--cf --configuration-file

Path to device test JSON file. If not specified, attestation and device definition parameters must be specified.

--connection-string --cs

Edge module connection stringWhen choosing IotEdgeCompatible badge type, connection string and attestaion-type of connection string are required.

--device-type --dt

Defines the type of device to be tested.

accepted values: DevKit, FinishedProduct

--ek --endorsement-key

TPM endorsement key for a TPM device. When choosing TPM as attestation type, endorsement key is required.

--models -m

Path containing Azure IoT Plug and Play interfaces implemented by the device being tested. When badge type is Pnp, models is required.

--product-id -p

The submitted product id. Required when validation-type is 'Certification'.

--skip-provisioning --sp

Determines whether the service skips generating provisioning configuration. Only applies to SymmetricKey and ConnectionString provisioning types.

default value: False

--validation-type --vt

The type of validations testing to be performed.

accepted values: Certification, Test

default value: Test

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 search

Deprecated

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

Search product repository for testing data.

az iot product test search [--base-url]
                           [--certificate-name]
                           [--product-id]
                           [--registration-id]

Examples

Search by product id

az iot product test search --product-id {product_id}

Search by DPS registration

az iot product test search --registration-id {registration_id}

Search by x509 certifcate common name (CN)

az iot product test search --certificate-name {certificate_name}

Search by multiple values

az iot product test search --product-id {product_id} --certificate-name {certificate_name}

Optional Parameters

--base-url

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

--certificate-name --cn

The x509 Certificate Common Name (cn) used for Device Provisioning Service attestation.

--product-id -p

The submitted product id.

--registration-id -r

The regstration Id for Device Provisioning Service.

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 show

Deprecated

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

View product test data.

az iot product test show --test-id
                         [--base-url]

Examples

Basic usage

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

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.

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 update

Deprecated

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

Update the product certification test data.

az iot product test update --test-id
                           [--at {ConnectionString, SymmetricKey, TPM, X509}]
                           [--badge-type {IotDevice, IotEdgeCompatible, Pnp}]
                           [--base-url]
                           [--certificate-path]
                           [--cf]
                           [--connection-string]
                           [--ek]
                           [--models]

Examples

Basic usage

az iot product test update --test-id {test_id} --configuration-file {configuration_file}

Required Parameters

--test-id -t

The generated Id for the device certification test.

Optional Parameters

--at --attestation-type

How the device will authenticate to testing service Device Provisioning Service.

accepted values: ConnectionString, SymmetricKey, TPM, X509

--badge-type --bt

The type of certification badge.

accepted values: IotDevice, IotEdgeCompatible, Pnp

--base-url

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

--certificate-path --cp

The path to the file containing the primary certificate. When choosing x509 as attestation type, one of the certificate path is required.

--cf --configuration-file

Path to device test JSON file. If not specified, attestation and device definition parameters must be specified.

--connection-string --cs

Edge module connection stringWhen choosing IotEdgeCompatible badge type, connection string and attestaion-type of connection string are required.

--ek --endorsement-key

TPM endorsement key for a TPM device. When choosing TPM as attestation type, endorsement key is required.

--models -m

Path containing Azure IoT Plug and Play interfaces implemented by the device being tested. When badge type is Pnp, models is required.

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

Commands

az iot product test create

Examples

Optional Parameters

az iot product test search

Examples

Optional Parameters

az iot product test show

Examples

Required Parameters

Optional Parameters

az iot product test update

Examples

Required Parameters

Optional Parameters

Feedback

Additional resources