az iot ops asset endpoint certificate

Note

This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.46.0 or higher). The extension will automatically install the first time you run an az iot ops asset endpoint certificate command. Learn more about extensions.

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

Manage owned certificates in an asset endpoint.

Commands

Name	Description	Type	Status
az iot ops asset endpoint certificate add	Add an owned certificate to an asset endpoint.	Extension	Preview
az iot ops asset endpoint certificate list	List owned certificates in an asset endpoint.	Extension	Preview
az iot ops asset endpoint certificate remove	Remove an owned certificate in an asset endpoint.	Extension	Preview

az iot ops asset endpoint certificate add

Preview

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

Add an owned certificate to an asset endpoint.

az iot ops asset endpoint certificate add --endpoint
                                          --resource-group
                                          --secret-ref
                                          --thumbprint
                                          [--password-ref]

Examples

Add a certificate to an asset endpoint.

az iot ops asset endpoint certificate add --endpoint {asset_endpoint} -g {resource_group} --secret-ref {secret_reference} --thumbprint {thumbprint} --password-ref {password_reference}

Add a certificate to an asset endpoint that uses a password with prefilled values.

az iot ops asset endpoint certificate add --endpoint myAssetEndpoint -g myRG --secret-ref "aio-opc-ua-broker-client/certificate" --thumbprint 000000000000000000 --password-ref "aio-opc-ua-broker-client/certificate-password"

Required Parameters

--endpoint

Asset Endpoint name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--secret-ref --sr

Reference for the der file that contains the certificate. The referenced file should contain the certificate and the key.

--thumbprint -t

Certificate thumbprint.

Optional Parameters

--password-ref --pr

Reference for pem file that contains the certificate password.

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 ops asset endpoint certificate list

Preview

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

List owned certificates in an asset endpoint.

az iot ops asset endpoint certificate list --endpoint
                                           --resource-group

Examples

List all owned certificates in an asset endpoint.

az iot ops asset endpoint certificate list --endpoint {asset_endpoint} -g {resource_group}

Required Parameters

--endpoint

Asset Endpoint name.

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

--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 ops asset endpoint certificate remove

Preview

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

Remove an owned certificate in an asset endpoint.

az iot ops asset endpoint certificate remove --endpoint
                                             --resource-group
                                             --thumbprint

Examples

Remove a certificate from an asset endpoint.

az iot ops asset endpoint certificate remove --endpoint {asset_endpoint} -g {resource_group} --thumbprint {thumbprint}

Required Parameters

--endpoint

Asset Endpoint name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--thumbprint -t

Certificate thumbprint.

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.