az iot hub certificate root-authority

  • 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 hub certificate root-authority command. Learn more about extensions.

This command group has been deprecated and will be removed in a future release.

Manage the certificate root-authority for an IoT Hub instance.

Commands

Name Description Type Status
az iot hub certificate root-authority set

Set the certificate root-authority for an IoT Hub instance to a specific version.

 Extension Deprecated
az iot hub certificate root-authority show

Show the current certificate root-authority for an IoT Hub instance.

 Extension Deprecated

az iot hub certificate root-authority set

Deprecated

This command is implicitly deprecated because command group 'iot hub certificate root-authority' is deprecated and will be removed in a future release.

Set the certificate root-authority for an IoT Hub instance to a specific version.

Transition this resource to a certificate on the DigiCert Global G2 root (v2) or revert to Baltimore root (v1). Before making this transition, please ensure all devices are updated to contain the public portion of the root that the IoT Hub will be transitioned to. Devices will disconnect and reconnect using the new root. We suggest monitoring current connections but an user defined metric may be more appropriate for your situation.

az iot hub certificate root-authority set --cav {v1, v2}
                                          --hub-name
                                          [--resource-group]
                                          [--yes {false, true}]

Examples

Transition the target IoT Hub certificate root authority to Digicert.

az iot hub certificate root-authority set --hub-name {iothub_name} --certificate-authority v2

Revert the target IoT Hub certificate root authority to Baltimore.

az iot hub certificate root-authority set --hub-name {iothub_name} --certificate-authority v1

Required Parameters

--cav --certificate-authority

Certificate Root Authority version. The v1 represents Baltimore CA and v2 represents Digicert CA.

accepted values: v1, v2
--hub-name

IoT Hub name. Required if --login is not provided.

Optional Parameters

--resource-group -g

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

--yes -y

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

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 hub certificate root-authority show

Deprecated

This command is implicitly deprecated because command group 'iot hub certificate root-authority' is deprecated and will be removed in a future release.

Show the current certificate root-authority for an IoT Hub instance.

az iot hub certificate root-authority show --hub-name
                                           [--resource-group]

Examples

Show the target IoT Hub certificate root authority.

az iot hub certificate root-authority show --hub-name {iothub_name}

Required Parameters

--hub-name

IoT Hub name. Required if --login is not provided.

Optional Parameters

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